Skip to content

Commit 38d7e9f

Browse files
mrxzmrxz
authored
Update attribute mapping tables in the docs for mesh primitives (#5646)
* Update docs-primitive generation script to output formatted Markdown tables * Updated attribute mapping table in docs for all meshPrimitives
1 parent 78b04f0 commit 38d7e9f

File tree

15 files changed

+367
-41
lines changed

15 files changed

+367
-41
lines changed

‎docs/primitives/a-box.md‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,32 +29,55 @@ The box primitive creates shapes such as boxes, cubes, or walls.
2929

3030
| Attribute | Component Mapping | Default Value |
3131
| -------- | ----------------- | ------------- |
32+
| alpha-test | material.alphaTest | 0 |
3233
| ambient-occlusion-map | material.ambientOcclusionMap | None |
3334
| ambient-occlusion-map-intensity | material.ambientOcclusionMapIntensity | 1 |
3435
| ambient-occlusion-texture-offset | material.ambientOcclusionTextureOffset | 0 0 |
3536
| ambient-occlusion-texture-repeat | material.ambientOcclusionTextureRepeat | 1 1 |
37+
| anisotropy | material.anisotropy | 0 |
38+
| blending | material.blending | normal |
3639
| color | material.color | #FFF |
3740
| depth | geometry.depth | 1 |
41+
| depth-test | material.depthTest | true |
42+
| depth-write | material.depthWrite | true |
3843
| displacement-bias | material.displacementBias | 0.5 |
3944
| displacement-map | material.displacementMap | None |
4045
| displacement-scale | material.displacementScale | 1 |
4146
| displacement-texture-offset | material.displacementTextureOffset | 0 0 |
4247
| displacement-texture-repeat | material.displacementTextureRepeat | 1 1 |
48+
| dithering | material.dithering | true |
49+
| emissive | material.emissive | #000 |
50+
| emissive-intensity | material.emissiveIntensity | 1 |
4351
| env-map | material.envMap | None |
44-
| fog | material.fog | true |
52+
| flat-shading | material.flatShading | false |
4553
| height | geometry.height | 1 |
54+
| material-fog | material.fog | true |
55+
| material-visible | material.visible | true |
4656
| metalness | material.metalness | 0 |
57+
| metalness-map | material.metalnessMap | None |
58+
| metalness-texture-offset | material.metalnessTextureOffset | 0 0 |
59+
| metalness-texture-repeat | material.metalnessTextureRepeat | 1 1 |
4760
| normal-map | material.normalMap | None |
4861
| normal-scale | material.normalScale | 1 1 |
4962
| normal-texture-offset | material.normalTextureOffset | 0 0 |
5063
| normal-texture-repeat | material.normalTextureRepeat | 1 1 |
64+
| npot | material.npot | false |
65+
| offset | material.offset | 0 0 |
66+
| opacity | material.opacity | 1 |
5167
| repeat | material.repeat | 1 1 |
5268
| roughness | material.roughness | 0.5 |
69+
| roughness-map | material.roughnessMap | None |
70+
| roughness-texture-offset | material.roughnessTextureOffset | 0 0 |
71+
| roughness-texture-repeat | material.roughnessTextureRepeat | 1 1 |
5372
| segments-depth | geometry.segmentsDepth | 1 |
5473
| segments-height | geometry.segmentsHeight | 1 |
5574
| segments-width | geometry.segmentsWidth | 1 |
75+
| shader | material.shader | standard |
76+
| side | material.side | front |
5677
| spherical-env-map | material.sphericalEnvMap | None |
5778
| src | material.src | None |
79+
| transparent | material.transparent | false |
80+
| vertex-colors-enabled | material.vertexColorsEnabled | false |
5881
| width | geometry.width | 1 |
5982
| wireframe | material.wireframe | false |
6083
| wireframe-linewidth | material.wireframeLinewidth | 2 |

‎docs/primitives/a-circle.md‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,32 +29,55 @@ component with the type set to `circle`.
2929

3030
| Attribute | Component Mapping | Default Value |
3131
| -------- | ----------------- | ------------- |
32+
| alpha-test | material.alphaTest | 0 |
3233
| ambient-occlusion-map | material.ambientOcclusionMap | None |
3334
| ambient-occlusion-map-intensity | material.ambientOcclusionMapIntensity | 1 |
3435
| ambient-occlusion-texture-offset | material.ambientOcclusionTextureOffset | 0 0 |
3536
| ambient-occlusion-texture-repeat | material.ambientOcclusionTextureRepeat | 1 1 |
37+
| anisotropy | material.anisotropy | 0 |
38+
| blending | material.blending | normal |
3639
| color | material.color | #FFF |
40+
| depth-test | material.depthTest | true |
41+
| depth-write | material.depthWrite | true |
3742
| displacement-bias | material.displacementBias | 0.5 |
3843
| displacement-map | material.displacementMap | None |
3944
| displacement-scale | material.displacementScale | 1 |
4045
| displacement-texture-offset | material.displacementTextureOffset | 0 0 |
4146
| displacement-texture-repeat | material.displacementTextureRepeat | 1 1 |
47+
| dithering | material.dithering | true |
48+
| emissive | material.emissive | #000 |
49+
| emissive-intensity | material.emissiveIntensity | 1 |
4250
| env-map | material.envMap | None |
43-
| fog | material.fog | true |
51+
| flat-shading | material.flatShading | false |
4452
| height | material.height | 256 |
53+
| material-fog | material.fog | true |
54+
| material-visible | material.visible | true |
4555
| metalness | material.metalness | 0 |
56+
| metalness-map | material.metalnessMap | None |
57+
| metalness-texture-offset | material.metalnessTextureOffset | 0 0 |
58+
| metalness-texture-repeat | material.metalnessTextureRepeat | 1 1 |
4659
| normal-map | material.normalMap | None |
4760
| normal-scale | material.normalScale | 1 1 |
4861
| normal-texture-offset | material.normalTextureOffset | 0 0 |
4962
| normal-texture-repeat | material.normalTextureRepeat | 1 1 |
63+
| npot | material.npot | false |
64+
| offset | material.offset | 0 0 |
65+
| opacity | material.opacity | 1 |
5066
| radius | geometry.radius | 1 |
5167
| repeat | material.repeat | 1 1 |
5268
| roughness | material.roughness | 0.5 |
69+
| roughness-map | material.roughnessMap | None |
70+
| roughness-texture-offset | material.roughnessTextureOffset | 0 0 |
71+
| roughness-texture-repeat | material.roughnessTextureRepeat | 1 1 |
5372
| segments | geometry.segments | 32 |
73+
| shader | material.shader | standard |
74+
| side | material.side | front |
5475
| spherical-env-map | material.sphericalEnvMap | None |
5576
| src | material.src | None |
5677
| theta-length | geometry.thetaLength | 360 |
5778
| theta-start | geometry.thetaStart | 0 |
79+
| transparent | material.transparent | false |
80+
| vertex-colors-enabled | material.vertexColorsEnabled | false |
5881
| width | material.width | 512 |
5982
| wireframe | material.wireframe | false |
6083
| wireframe-linewidth | material.wireframeLinewidth | 2 |

‎docs/primitives/a-cone.md‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,38 +24,60 @@ The cone primitive creates a cone shape.
2424

2525
## Attributes
2626

27-
2827
| Attribute | Component Mapping | Default Value |
2928
| -------- | ----------------- | ------------- |
29+
| alpha-test | material.alphaTest | 0 |
3030
| ambient-occlusion-map | material.ambientOcclusionMap | None |
3131
| ambient-occlusion-map-intensity | material.ambientOcclusionMapIntensity | 1 |
3232
| ambient-occlusion-texture-offset | material.ambientOcclusionTextureOffset | 0 0 |
3333
| ambient-occlusion-texture-repeat | material.ambientOcclusionTextureRepeat | 1 1 |
34+
| anisotropy | material.anisotropy | 0 |
35+
| blending | material.blending | normal |
3436
| color | material.color | #FFF |
37+
| depth-test | material.depthTest | true |
38+
| depth-write | material.depthWrite | true |
3539
| displacement-bias | material.displacementBias | 0.5 |
3640
| displacement-map | material.displacementMap | None |
3741
| displacement-scale | material.displacementScale | 1 |
3842
| displacement-texture-offset | material.displacementTextureOffset | 0 0 |
3943
| displacement-texture-repeat | material.displacementTextureRepeat | 1 1 |
44+
| dithering | material.dithering | true |
45+
| emissive | material.emissive | #000 |
46+
| emissive-intensity | material.emissiveIntensity | 1 |
4047
| env-map | material.envMap | None |
41-
| fog | material.fog | true |
48+
| flat-shading | material.flatShading | false |
4249
| height | geometry.height | 1 |
50+
| material-fog | material.fog | true |
51+
| material-visible | material.visible | true |
4352
| metalness | material.metalness | 0 |
53+
| metalness-map | material.metalnessMap | None |
54+
| metalness-texture-offset | material.metalnessTextureOffset | 0 0 |
55+
| metalness-texture-repeat | material.metalnessTextureRepeat | 1 1 |
4456
| normal-map | material.normalMap | None |
4557
| normal-scale | material.normalScale | 1 1 |
4658
| normal-texture-offset | material.normalTextureOffset | 0 0 |
4759
| normal-texture-repeat | material.normalTextureRepeat | 1 1 |
60+
| npot | material.npot | false |
61+
| offset | material.offset | 0 0 |
62+
| opacity | material.opacity | 1 |
4863
| open-ended | geometry.openEnded | false |
4964
| radius-bottom | geometry.radiusBottom | 1 |
50-
| radius-top | geometry.radiusTop | 0.8 |
65+
| radius-top | geometry.radiusTop | 0.01 |
5166
| repeat | material.repeat | 1 1 |
5267
| roughness | material.roughness | 0.5 |
68+
| roughness-map | material.roughnessMap | None |
69+
| roughness-texture-offset | material.roughnessTextureOffset | 0 0 |
70+
| roughness-texture-repeat | material.roughnessTextureRepeat | 1 1 |
5371
| segments-height | geometry.segmentsHeight | 18 |
5472
| segments-radial | geometry.segmentsRadial | 36 |
73+
| shader | material.shader | standard |
74+
| side | material.side | front |
5575
| spherical-env-map | material.sphericalEnvMap | None |
5676
| src | material.src | None |
5777
| theta-length | geometry.thetaLength | 360 |
5878
| theta-start | geometry.thetaStart | 0 |
79+
| transparent | material.transparent | false |
80+
| vertex-colors-enabled | material.vertexColorsEnabled | false |
5981
| width | material.width | 512 |
6082
| wireframe | material.wireframe | false |
6183
| wireframe-linewidth | material.wireframeLinewidth | 2 |

0 commit comments

Comments
 (0)