| |
accessType and type Credits and Translations X3D Resources  |
Anchor |
[inherits X3DGroupingNode, implements X3DUrlObject]
Anchor is a Grouping node that can contain most nodes. When the user selects any of the geometry contained by the Anchor
node, the browser either jumps to another viewpoint (similar to HTML bookmark) or else loads content (such as X3D, an image
or HTML) specified by the url field.
Newly loaded content completely replaces current content, if the value of parameter field indicates using the same window.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: apply containerField='watchList' when parent node is LoadSensor. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DChildNode]
Grouping nodes contain an ordered list of children nodes.
Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus
transformations accumulate down the scene graph hierarchy.
Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e.
matching DEF, USE values) are ignored.
Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching
DEF, USE values) are ignored.
Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided text tooltip that tells users the expected action of this node.
Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value
(such as & for & ampersand character, or " for " quotation-mark character).
|
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Address of replacement world, or #ViewpointDEFName within the current scene, or alternate Web resource, activated by the
user selecting Shape geometry within the Anchor children nodes.
Hint: jump to a world's internal viewpoint by appending viewpoint name (e.g. #ViewpointName, someOtherCoolWorld.x3d#GrandTour).
Hint: jump to a local viewpoint by only using viewpoint name (e.g. #GrandTour).
Hint: binding a different Viewpoint triggers an isBound event that can initiate other user-arrival reactions via event chains
to interpolators or scripts.
Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems
are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all
case sensitive and intolerant of uppercase/lowercase mismatches.
Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
Hint: pop up a new window with url value as follows: "JavaScript:window.open('somePage.html','popup','width=240,height=240');location.href='HelloWorld.x3d'"
Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
|
| parameter |
[parameter accessType inputOutput, type MFString CDATA #IMPLIED]
If provided, parameter tells the X3D player where to to redirect the loaded url.
Hint: set parameter value as target=_blank to load the target url into a new browser frame.
Hint: set parameter value as target=frame_name to load target url into another browser frame.
Hint: MFString arrays can have multiple values, so separate each individual string by quote marks. "https://www.web3d.org" "https://www.web3d.org/about" "etc."
Interchange profile hint: this field may be ignored, applying the default value regardless.
|
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local
coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"]
Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time
with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization
or constraint.
Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| containerField |
[containerField type NMTOKEN (children | watchList) "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Appearance |
[inherits X3DAppearanceNode]
Appearance specifies the visual properties of geometry
by containing the Material, ImageTexture/MovieTexture/PixelTexture, FillProperties, LineProperties, programmable shader nodes
(ComposedShader, PackagedShader, ProgramShader) and TextureTransform nodes.
Hint: insert a Shape node before adding geometry or Appearance.
Interchange profile hint: only Material and ImageTexture children are allowed.
Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
Hint:
Advanced uses can contain MultiTexture, MultiTextureTransform/TextureTransformMatrix3D/TextureTransform3D, ComposedShader/PackagedShader/ProgramShader,
ComposedTexture3D/ImageTexture3D/PixelTexture3D, or ComposedCubeMapTexture/GeneratedCubeMapTexture/ImageCubeMapTexture.
Hint: X3D Architecture 12.2.2 Appearance node https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shape.html#Appearancenode
Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/lighting.html#Lightingmodel |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| material |
[material accessType inputOutput, type SFNode singleton, NULL node] [X3DMaterialNode]
Single contained Material node that specifies visual attributes for lighting response (color types, transparency, etc.)
applied to corresponding geometry.
Warning: if material is NULL or unspecified, lighting is off (all lights ignored) for this Shape and unlit object color is (1, 1,
1).
|
| fillProperties |
[fillProperties accessType inputOutput, type SFNode singleton, NULL node] [FillProperties]
Single contained FillProperties node that specifies additional visual attributes applied to polygonal areas of corresponding
geometry, on top of whatever other appearance is already defined.
|
| lineProperties |
[lineProperties accessType inputOutput, type SFNode singleton, NULL node] [LineProperties]
Single contained LineProperties node that specifies additional visual attributes applied to corresponding line geometry.
|
| shaders |
[shaders accessType inputOutput, type MFNode array, empty list] [X3DShaderNode]
Zero or more contained programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) that specify, in order
of preference, author-programmed rendering characteristics.
Hint: X3D Architecture 31 Programmable shaders component https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shaders.html
|
| texture |
[texture accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureNode]
Single contained texture node (ImageTexture, MovieTexture, PixelTexture, MultiTexture) that maps image(s) to surface geometry.
Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured.
Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
Hint: X3D Architecture 18 Texturing component https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html
Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texture3D.html
|
| textureTransform |
[textureTransform accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureTransformNode]
Single contained TextureTransform node that defines 2D transformation applied to texture coordinates.
Hint: if textureTransform array is empty, then this field has no effect.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| containerField |
[containerField type NMTOKEN "appearance"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Arc2D |
[inherits X3DGeometryNode]
Arc2D is a line-based geometry node that defines a linear circular arc with center (0,0) in X-Y plane, with angles measured
starting at positive x-axis and sweeping towards positive y-axis.
Hint: Material emissiveColor in corresponding Appearance is used for rendering lines.
Warning: lines are not lit, are not texture-mapped, and do not participate in collision detection.
Warning: use a different Material emissiveColor than the Background color, otherwise geometry is invisible.
Hint: adding LineProperties to the corresponding Appearance node can modify the rendering style of these lines.
Hint: insert a Shape node before adding geometry or Appearance.
Warning: requires X3D profile='Full' or else include <component name='Geometry2D' level='2'/>
Examples: X3D Example Archives, X3D for Web Authors, Chapter 10 Geometry 2D https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter10Geometry2D |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| radius |
[radius accessType initializeOnly, type SFFloat CDATA "1"] (0,+∞)
circle radius, of which the arc is a portion.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
|
| startAngle |
[startAngle accessType initializeOnly, type SFFloat CDATA "0"] [0,2pi]
Arc extends from startAngle counterclockwise to endAngle, in radians.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
Hint: https://en.wikipedia.org/wiki/Radian
|
| endAngle |
[endAngle accessType initializeOnly, type SFFloat CDATA "1.570796"] [0,2pi]
Arc extends from startAngle counterclockwise to endAngle, in radians.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
Hint: https://en.wikipedia.org/wiki/Radian
|
| containerField |
[containerField type NMTOKEN "geometry"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
ArcClose2D |
[inherits X3DGeometryNode]
ArcClose2D is a polygonal geometry node that defines a linear circular arc, closed by PIE or CHORD line segments, with center
(0,0) in X-Y plane, with angles measured starting at positive x-axis and sweeping towards positive y-axis.
Hint: insert a Shape node before adding geometry or Appearance.
Warning: requires X3D profile='Full' or else include <component name='Geometry2D' level='2'/>
Examples: X3D Example Archives, X3D for Web Authors, Chapter 10 Geometry 2D https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter10Geometry2D |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| radius |
[radius accessType initializeOnly, type SFFloat CDATA "1"] (0,+∞)
circle radius, of which the arc is a portion.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
|
| startAngle |
[startAngle accessType initializeOnly, type SFFloat CDATA "0"] [0,2pi]
Arc extends from startAngle counterclockwise to endAngle, in radians.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
Hint: https://en.wikipedia.org/wiki/Radian
|
| endAngle |
[endAngle accessType initializeOnly, type SFFloat CDATA "1.570796"] [0,2pi]
Arc extends from startAngle counterclockwise to endAngle, in radians.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
Hint: https://en.wikipedia.org/wiki/Radian
|
| closureType |
[closureType accessType initializeOnly, type SFString CDATA (PIE|CHORD) "PIE"]
Defines whether pair of line segments connect to center (PIE), or single line-segment chord connects arc endpoints (CHORD).
Warning: simple-geometry parameters cannot be changed after initial creation.
|
| solid |
[solid accessType initializeOnly, type SFBool (true|false) "false"]
Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides
of polygons (backface culling off).
Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
Warning: default value true can completely hide geometry if viewed from wrong side!
Hint: if in doubt, use solid='false' for maximum visibility.
Warning: solid false not supported in VRML97.
|
| containerField |
[containerField type NMTOKEN "geometry"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
AudioClip |
[inherits X3DSoundSourceNode, implements X3DUrlObject]
AudioClip provides audio data used by parent Sound nodes.
Hint: add a parent Sound node first.
Hint: utilize DEF/USE references for multiple copies of a single AudioClip sound file in order to avoid multiple-download delays,
reduce memory requirements, and maintain synchronization.
Hint: authors can provide multiple audio formats for the same audio track, with each source address listed separately in the url
field.
Hint: player support for .wav format is required, .midi format is recommended, other formats are optional.
Hint: X3D Scene Authoring Hints:Audio https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Audio
Hint: apply containerField='watchList' when parent node is LoadSensor. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided text tooltip that tells users the expected action of this node.
Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value
(such as & for & ampersand character, or " for " quotation-mark character).
|
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Location and filename of sound file or stream. Support for .wav format is required, .midi format is recommended, other formats
are optional.
Hint: MFString arrays can have multiple values, so separate each individual string by quote marks. "https://www.web3d.org" "https://www.web3d.org/about" "etc."
Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems
are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all
case sensitive and intolerant of uppercase/lowercase mismatches.
Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
|
| loop |
[loop accessType inputOutput, type SFBool (true|false) "false"]
Repeat indefinitely when loop=true, repeat only once when loop=false.
|
| pitch |
[pitch accessType inputOutput, type SFFloat CDATA "1.0"] (0,+∞)
Multiplier for the rate at which sampled sound is played. Changing pitch also changes playback speed.
Hint: changing the pitch field does not trigger a duration_changed event. Playback interval may vary but duration of the original
media data remains unmodified.
|
| startTime |
[startTime accessType inputOutput, type SFTime CDATA "0"]
Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
|
| stopTime |
[stopTime accessType inputOutput, type SFTime CDATA "0"]
Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
|
| duration_changed |
[duration_changed accessType outputOnly, type SFTime CDATA #FIXED ""] [0,+∞)
or -1. duration_changed is length of time in seconds for one cycle of media stream.
Warning: duration value of -1 implies that media data has not yet loaded or is unavailable for some reason.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
Hint: duration_changed is an SFTime duration interval, normally nonnegative, and not an absolute clock time.
Hint: changing the pitch field does not trigger a duration_changed event. Playback interval may vary but duration of the original
media data remains unmodified.
|
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when playback starts/stops.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| isPaused |
[isPaused accessType outputOnly, type SFBool #FIXED ""]
isPaused true/false events are sent when AudioClip is paused/resumed.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| pauseTime |
[pauseTime accessType inputOutput, type SFTime CDATA "0"]
When time now >= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January
1, 1970, 00:00:00 GMT.
Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
|
| resumeTime |
[resumeTime accessType inputOutput, type SFTime CDATA "0"]
When resumeTime becomes <= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds
since January 1, 1970, 00:00:00 GMT.
Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
|
| elapsedTime |
[elapsedTime accessType outputOnly, type SFTime CDATA #FIXED ""] [0,+∞)
Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
Hint: elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time.
|
| containerField |
[containerField type NMTOKEN "source"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Background |
[inherits X3DBackgroundNode]
Background simulates ground and sky, using vertical arrays of wraparound color values. Background can also provide url addresses
for backdrop textures on all six sides.
Hint: Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground and Viewpoint are bindable nodes, meaning
that no more than one of each node type can be active at a given time.
Warning: results are undefined if a bindable node (Background, Fog, NavigationInfo, OrthoViewpoint, TextureBackground, Viewpoint)
is a contained descendant node of either LOD or Switch.
Hint: X3D Example Archives, Basic, Universal Media Panoramas https://www.web3d.org/x3d/content/examples/Basic/UniversalMediaPanoramas |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| transparency |
(X3D version 3.2 or later) [transparency accessType inputOutput, type SFFloat CDATA "0"] [0,1]
how "clear" the background is, allows underlying page to show through: 1.0 is completely transparent, 0.0 is completely
opaque.
Interchange profile hint: transparency < .5 opaque, transparency > .5 transparent.
|
| skyColor |
[skyColor accessType inputOutput, type MFColor CDATA "0 0 0"]
Color of the sky at various angles on the sky sphere. First value is color of sky at 0.0 radians representing the zenith
(straight up).
Hint: setting the same color at two consecutive angles produces a solid color band.
Warning: you must have one more skyColor value than skyAngle values.
Interchange profile hint: only one color might be rendered, others can be ignored.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
|
| skyAngle |
[skyAngle accessType inputOutput, type MFFloat CDATA #IMPLIED] [0,π]
The angle array values increase from 0.0 zenith (straight up) to π/2=1.570796 (horizon) to π=3.14159 (nadir).
Warning: you must have one more skyColor value than skyAngle values.
Warning: colors at skyAngle=0 are ignored.
Interchange profile hint: this field may be ignored, applying the default value regardless.
Hint: https://en.wikipedia.org/wiki/Radian
|
| groundColor |
[groundColor accessType inputOutput, type MFColor CDATA #IMPLIED]
Color of the ground at the various angles on the ground partial sphere. First value is color of ground at 0.0 radians representing
the nadir (straight down).
Hint: setting the same color at two consecutive angles produces a solid color band.
Warning: you must have one more groundColor value than groundAngle values.
Interchange profile hint: this field may be ignored, applying the default value regardless.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
|
| groundAngle |
[groundAngle accessType inputOutput, type MFFloat CDATA #IMPLIED] [0,π/2]
The angle array values increase from 0.0 nadir (straight down) to π/2=1.570796 (horizon).
Warning: you must have one more groundColor value than groundAngle values.
Warning: colors at groundAngle=0 are ignored.
Interchange profile hint: this field may be ignored, applying the default value regardless.
Hint: https://en.wikipedia.org/wiki/Radian
|
| frontUrl |
[frontUrl accessType inputOutput, type MFString CDATA #IMPLIED]
Image background panorama between ground/sky backdrop and scene's geometry.
Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems
are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all
case sensitive and intolerant of uppercase/lowercase mismatches.
Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
Interchange profile hint: this field may be ignored, applying the default value regardless.
|
| backUrl |
[backUrl accessType inputOutput, type MFString CDATA #IMPLIED]
Image background panorama between ground/sky backdrop and scene's geometry.
Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems
are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all
case sensitive and intolerant of uppercase/lowercase mismatches.
Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
Interchange profile hint: this field may be ignored, applying the default value regardless.
|
| leftUrl |
[leftUrl accessType inputOutput, type MFString CDATA #IMPLIED]
Image background panorama between ground/sky backdrop and scene's geometry.
Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems
are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all
case sensitive and intolerant of uppercase/lowercase mismatches.
Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
Interchange profile hint: this field may be ignored, applying the default value regardless.
|
| rightUrl |
[rightUrl accessType inputOutput, type MFString CDATA #IMPLIED]
Image background panorama between ground/sky backdrop and scene's geometry.
Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems
are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all
case sensitive and intolerant of uppercase/lowercase mismatches.
Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
Interchange profile hint: this field may be ignored, applying the default value regardless.
|
| topUrl |
[topUrl accessType inputOutput, type MFString CDATA #IMPLIED]
Image background panorama between ground/sky backdrop and scene's geometry.
Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems
are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all
case sensitive and intolerant of uppercase/lowercase mismatches.
Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
Interchange profile hint: this field may be ignored, applying the default value regardless.
|
| bottomUrl |
[bottomUrl accessType inputOutput, type MFString CDATA #IMPLIED]
Image background panorama between ground/sky backdrop and scene's geometry.
Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems
are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all
case sensitive and intolerant of uppercase/lowercase mismatches.
Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
Interchange profile hint: this field may be ignored, applying the default value regardless.
|
| set_bind |
[set_bind accessType inputOnly, type SFBool #FIXED ""]
Input event set_bind=true makes this node active, input event set_bind=false makes this node inactive. Thus setting set_bind
true/false will pop/push (enable/disable) this node.
Hint: paired node operations can be established by connecting set_bind and isBound fields of corresponding bindable nodes.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| isBound |
[isBound accessType outputOnly, type SFBool #FIXED ""]
event true sent when node becomes active, event false sent when unbound by another node.
Hint: paired node operations can be established by connecting set_bind and isBound fields of corresponding bindable nodes.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| bindTime |
[bindTime accessType outputOnly, type SFTime CDATA #FIXED ""]
event sent when node becomes active/inactive.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
BallJoint |
(X3D version 3.2 or later) [inherits X3DRigidJointNode]
BallJoint represents an unconstrained joint between two bodies that pivot about a common anchor point.
Contains two RigidBody nodes (containerField values body1, body2).
Hint: RigidBodyPhysics component, level 2. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| anchorPoint |
[anchorPoint accessType inputOutput, type SFVec3f CDATA "0 0 0"]
anchorPoint is joint center, specified in world coordinates.
|
| forceOutput |
[forceOutput accessType inputOutput, type MFString CDATA "NONE"]
forceOutput controls which output fields are generated for the next frame. Values are ALL, NONE, or exact names of output
fields updated at start of next frame.
|
| body1AnchorPoint |
[body1AnchorPoint accessType outputOnly, type SFVec3f CDATA]
body1AnchorPoint describes anchorPoint position relative to local coordinate reference frame.
Hint: can detect separation if body1AnchorPoint!=body2AnchorPoint.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| body2AnchorPoint |
[body2AnchorPoint accessType outputOnly, type SFVec3f CDATA]
body2AnchorPoint describes anchorPoint position relative to local coordinate reference frame.
Hint: can detect separation if body1AnchorPoint!=body2AnchorPoint.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "joints"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Billboard |
[inherits X3DGroupingNode]
Billboard is a Grouping node that can contain most nodes. Contained child geometry faces the user, rotating about the specified
axis.
Set axisOfRotation=0 0 0 to fully face the user's camera.
Hint: Put Billboard as close to the geometry as possible,
nested inside Transform for local coordinate system.
Warning: don't put Viewpoint inside a Billboard.
Hint: insert a Shape node before adding geometry or Appearance. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DChildNode]
Grouping nodes contain an ordered list of children nodes.
Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus
transformations accumulate down the scene graph hierarchy.
Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e.
matching DEF, USE values) are ignored.
Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching
DEF, USE values) are ignored.
Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| axisOfRotation |
[axisOfRotation accessType inputOutput, type SFVec3f CDATA "0 1 0"]
axisOfRotation direction is relative to local coordinate system.
Hint: axis 0 0 0 always faces viewer.
|
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local
coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"]
Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time
with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization
or constraint.
Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
BlendedVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
BlendedVolumeStyle combines rendering of two voxel data sets into one by blending voxel values.
Hint: BlendedVolumeStyle can contain just one each of following: VolumeStyle node with containerField='renderStyle', Texture3D
node with containerField='voxels', Texture2D node with containerField='weightTransferFunction1' and Texture2D node with containerField='weightTransferFunction2'.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| renderStyle |
[renderStyle accessType inputOutput, type SFNode singleton, NULL node] [X3DComposableVolumeRenderStyleNode]
Single contained X3DComposableVolumeRenderStyleNode node that defines specific rendering technique for data in the voxels
field, and the result is blended with parent VolumeData or SegmentedVoliumeData node.
|
| voxels |
[voxels accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture3DNode]
Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides second set of raw voxel
information utilized by corresponding rendering styles. Any number of color components (1-4) may be defined.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| weightConstant1 |
[weightConstant1 accessType inputOutput, type SFFloat CDATA "0.5"] [0,1]
weightConstant1 is used when weightFunction1=CONSTANT
|
| weightConstant2 |
[weightConstant2 accessType inputOutput, type SFFloat CDATA "0.5"] [0,1]
weightConstant2 is used when weightFunction2=CONSTANT
|
| weightFunction1 |
[weightFunction1 accessType inputOutput, type SFString CDATA ( CONSTANT | ALPHA1 | ALPHA2 | TABLE | ONE_MINUS_ALPHA1 | ONE_MINUS_ALPHA2 ) CONSTANT]
specifies 2D textures used to determine weight values when weight function is set to TABLE.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for
MFString values.
Hint: X3D Architecture Table 41.3, Weight function types https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-WeightFunctionTypes
Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-transferFunctionToWeightMapping
|
| weightFunction2 |
[weightFunction2 accessType inputOutput, type SFString CDATA ( CONSTANT | ALPHA1 | ALPHA2 | TABLE | ONE_MINUS_ALPHA1 | ONE_MINUS_ALPHA2 ) CONSTANT]
specifies 2D textures used to determine weight values when weight function is set to TABLE.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for
MFString values.
Hint: X3D Architecture Table 41.3, Weight function types https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-WeightFunctionTypes
Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-transferFunctionToWeightMapping
|
| containerField |
[containerField type NMTOKEN "renderStyle"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
BooleanFilter |
[inherits X3DChildNode]
BooleanFilter selectively passes true, false or negated events.
Hint: example scenes and authoring assets at http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
Hint: X3D Event-Utility Node Diagrams http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| set_boolean |
[set_boolean accessType inputOnly, type SFBool #FIXED ""]
set_boolean is the input value to be filtered.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| inputTrue |
[inputTrue accessType outputOnly, type SFBool #FIXED ""]
inputTrue only passes a true value, which occurs when set_boolean input is true.
Hint: inputTrue is an output event that can only provide a value of true.
|
| inputFalse |
[inputFalse accessType outputOnly, type SFBool #FIXED ""]
inputFalse only passes a false value, which occurs when set_boolean is false.
Hint: inputFalse is an output event that can only provide a value of false.
|
| inputNegate |
[inputNegate accessType outputOnly, type SFBool #FIXED ""]
inputNegate is an output event that provides an opposite value by negating set_boolean input.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
BooleanSequencer |
[inherits X3DSequencerNode]
BooleanSequencer generates periodic discrete Boolean values. Authors can ROUTE value_changed output events to other Boolean
attributes.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
Hint: example scenes and authoring assets at http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
Hint: X3D Event-Utility Node Diagrams http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| key |
[key accessType inputOutput, type MFFloat CDATA #IMPLIED]
Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to
a value in the keyValue array.
Warning: number of keys must match number of keyValues!
Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding
value.
Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
|
| keyValue |
[keyValue accessType inputOutput, type MFBool CDATA #IMPLIED]
Output values for linear sequencing, each corresponding to an input-fraction value in the key array.
Warning: number of keys must match number of keyValues!
|
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input key for corresponding keyValue output.
Hint: set_fraction values are typically in same range interval as values in the key array. Response to an input set_fraction value
less than minimum is equivalent to minimum key, and response to an input set_fraction value greater than maximum is equivalent
to maximum key.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| value_changed |
[value_changed accessType outputOnly, type SFBool #FIXED ""]
Single intermittent output value determined by current key time and corresponding keyValue entry.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| next |
[next accessType inputOnly, type SFBool (true|false) ""]
Send next output value in keyValue array, and reset internal fraction field to match corresponding value in key array.
Hint: this input event will "wrap around" boundary of keyValue array, i.e. continue from last to first if necessary.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| previous |
[previous accessType inputOnly, type SFBool (true|false) ""]
Send previous output value in keyValue array, and reset internal fraction field to match corresponding value in key array.
Hint: this input event will "wrap around" boundary of keyValue array, i.e. continue from first to last if necessary.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
BooleanToggle |
[inherits X3DChildNode]
BooleanToggle maintains state and negates output when a true input is provided.
Hint: example scenes and authoring assets at http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
Hint: X3D Event-Utility Node Diagrams http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| set_boolean |
[set_boolean accessType inputOnly, type SFBool #FIXED ""]
If input event set_boolean is true, flip state by negating current value of the toggle field
Hint: for logical consistency, input event set_boolean false has no effect (under review as part of Mantis issue 519).
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| toggle |
[toggle accessType inputOutput, type SFBool (true|false) "false"]
Persistent state value that gets toggled or reset.
Hint: directly setting a new value for the toggle field generates a corresponding toggle_changed output event.
|
| toggle_changed |
[toggle_changed accessType outputOnly, type SFInt32 CDATA #FIXED ""]
toggle_changed provides boolean output event matching updated toggle value when input event set_boolean true is received.
Hint: directly setting a new value for the toggle field generates a corresponding toggle_changed output event.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
BooleanTrigger |
[inherits X3DTriggerNode]
BooleanTrigger converts time events to boolean true events.
Hint: example scenes and authoring assets at http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
Hint: X3D Event-Utility Node Diagrams http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| set_triggerTime |
[set_triggerTime accessType inputOnly, type SFTime CDATA #FIXED ""]
set_triggerTime provides input time event, typical event sent is TouchSensor touchTime.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| triggerTrue |
[triggerTrue accessType outputOnly, type SFBool #FIXED ""]
triggerTrue outputs a true value whenever a triggerTime event is received.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
BoundaryEnhancementVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
BoundaryEnhancementVolumeStyle provides boundary enhancement for the volume rendering style. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| retainedOpacity |
[retainedOpacity accessType inputOutput, type SFFloat CDATA "0.2"] [0,1]
retainedOpacity k_gc is the amount of initial opacity to mix into the output
|
| boundaryOpacity |
[boundaryOpacity accessType inputOutput, type SFFloat CDATA "0.9"] [0,+∞)
boundaryOpacity k_gs is the factored amount of the gradient enhancement to use.
|
| opacityFactor |
[opacityFactor accessType inputOutput, type SFFloat CDATA "2"] [0,+∞)
opacityFactor k_ge is the power function to control the slope of the opacity curve to highlight the set of data.
|
| containerField |
[containerField type NMTOKEN "renderStyle"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
BoundedPhysicsModel |
(X3D version 3.2 or later) [inherits X3DParticlePhysicsModelNode]
BoundedPhysicsModel provides user-defined geometrical boundaries for particle motion. A child geometry node specifies boundaries
that constrain the location of the particles.
Hint: when a particle touches the boundary surface, it is reflected by the geometry (either inside or outside). |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| geometry |
[geometry accessType inputOutput, type SFNode singleton, NULL node] [X3DGeometryNode]
Single contained geometry node provides the geometry used for each particle when the parent ParticleSystem node has geometryType=GEOMETRY.
Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| containerField |
[containerField type NMTOKEN "physics"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Box |
[inherits X3DGeometryNode]
Box is a geometry node specifying a rectangular cuboid.
Hint: Cuboid https://en.wikipedia.org/wiki/Cuboid
Hint: Parallelepiped https://en.wikipedia.org/wiki/Parallelepiped
Hint: insert a Shape node before adding geometry or Appearance. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| size |
[size accessType initializeOnly, type SFVec3f CDATA "2 2 2"] (0,+∞)
size x y z in meters.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
|
| solid |
[solid accessType initializeOnly, type SFBool (true|false) "true"]
Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides
of polygons (backface culling off).
Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
Warning: default value true can completely hide geometry if viewed from wrong side!
Hint: if in doubt, use solid='false' for maximum visibility.
Warning: solid false not supported in VRML97.
|
| containerField |
[containerField type NMTOKEN "geometry"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
CADAssembly |
(X3D version 3.1 or later) [inherits X3DGroupingNode, implements X3DProductStructureChildNode]
CADAssembly holds a set of Computer-Aided Design (CAD) assemblies or parts grouped together. CADAssembly is a Grouping node
that can contain CADAssembly (subassembly), CADPart or CADFace nodes.
Hint: can also contain Shapes or other grouped content.
Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/ComputerAidedDesignInterchangeProfile.pdf
Warning: requires X3D profile='Full' or else include <component name='CADGeometry' level='2'/>
Hint: ViewpointGroup and OrthoViewpoint require Navigation component level 3, which is higher than CADInterchange profile. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DChildNode]
Grouping nodes contain an ordered list of children nodes.
Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus
transformations accumulate down the scene graph hierarchy.
Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e.
matching DEF, USE values) are ignored.
Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching
DEF, USE values) are ignored.
Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| name |
[name accessType inputOutput, type xs:token #IMPLIED]
Optional name for this particular CAD node.
Warning: name is not included if this instance is a USE node.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local
coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"]
Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time
with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization
or constraint.
Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
CADFace |
(X3D version 3.1 or later) [inherits X3DProductStructureChildNode, implements X3DBoundedObject]
CADFace holds geometry representing one face in a Computer-Aided Design (CAD) CADPart. CADFace can only contain a single
Shape or LOD node (with containerField='shape').
Warning: only zero or one Shape child is allowed to be active at one time.
Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/ComputerAidedDesignInterchangeProfile.pdf
Warning: requires X3D profile='Full' or else include <component name='CADGeometry' level='2'/> |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| shape |
[shape accessType inputOutput, type SFNode singleton, NULL node] [X3DShapeNode | LOD | Transform]
Contained Shape for this CADPart.
Warning: if LOD or Transform are used, only zero or one Shape child is allowed to be active at one time.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| name |
[name accessType inputOutput, type xs:token #IMPLIED]
Optional name for this particular CAD node.
Warning: name is not included if this instance is a USE node.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local
coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"]
Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time
with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization
or constraint.
Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
CADLayer |
(X3D version 3.1 or later) [inherits X3DGroupingNode]
CADLayer nodes define a hierarchy that shows layer structure for a Computer-Aided Design (CAD) model. CADLayer is a Grouping
node that can contain CADAssembly and most nodes.
Hint: can also contain Shapes or other grouped content.
Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/ComputerAidedDesignInterchangeProfile.pdf
Warning: requires X3D profile='Full' or else include <component name='CADGeometry' level='2'/> |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DChildNode]
Grouping nodes contain an ordered list of children nodes.
Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus
transformations accumulate down the scene graph hierarchy.
Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e.
matching DEF, USE values) are ignored.
Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching
DEF, USE values) are ignored.
Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| name |
[name accessType inputOutput, type xs:token #IMPLIED]
Optional name for this particular CAD node.
Warning: name is not included if this instance is a USE node.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| visible |
[visible accessType inputOutput, type MFBool CDATA #IMPLIED]
Array of boolean values that specify whether each individual child CADAssembly is visible.
|
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local
coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"]
Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time
with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization
or constraint.
Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
CADPart |
(X3D version 3.1 or later) [inherits X3DGroupingNode, implements X3DProductStructureChildNode]
CADPart is an atomic part that defines both coordinate-system location and the faces that constitute a part in a Computer-Aided
Design (CAD) model.
CADPart contains multiple CADFace nodes that make up a single part.
Hint: CADPart is often a child of CADAssembly node.
Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/ComputerAidedDesignInterchangeProfile.pdf
Warning: requires X3D profile='Full' or else include <component name='CADGeometry' level='2'/> |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DChildNode]
Grouping nodes contain an ordered list of children nodes.
Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus
transformations accumulate down the scene graph hierarchy.
Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e.
matching DEF, USE values) are ignored.
Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching
DEF, USE values) are ignored.
Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| name |
[name accessType inputOutput, type xs:token #IMPLIED]
Optional name for this particular CAD node.
Warning: name is not included if this instance is a USE node.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| translation |
[translation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position (x, y, z in meters) of children relative to local coordinate system.
Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the
center offset, then translation.
|
| rotation |
[rotation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Orientation (axis, angle in radians) of children relative to local coordinate system.
Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the
center offset, then translation.
|
| center |
[center accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Translation offset from origin of local coordinate system, applied prior to rotation or scaling.
Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the
center offset, then translation.
|
| scale |
[scale accessType inputOutput, type SFVec3f CDATA "1 1 1"]
Non-uniform x-y-z scale of child coordinate system, adjusted by center and scaleOrientation.
Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the
center offset, then translation.
|
| scaleOrientation |
[scaleOrientation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Preliminary rotation of coordinate system before scaling (to allow scaling around arbitrary orientations).
Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the
center offset, then translation.
|
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local
coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"]
Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time
with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization
or constraint.
Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
CartoonVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
CartoonVolumeStyle generates cartoon-style non-photorealistic rendering of associated volumetric data.
Hint: contains single Texture3D node with containerField='surfaceNormals' |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| colorSteps |
[colorSteps accessType inputOutput, type SFInt32 CDATA "4"] [1,64]
Number of distinct colors taken from interpolated colors and used to render the object.
Hint: colorSteps=1 means no color interpolation takes place, only use orthogonalColor.
Hint: parallelColor and orthogonalColor interpolation is in HSV color space for RGB components, linearly for alpha component.
|
| orthogonalColor |
[orthogonalColor accessType inputOutput, type SFColorRGBA CDATA "1 1 1 1"] [0,1]
orthogonalColor is used for surface normals that are orthogonal (perpendicular) to viewer's current location.
Hint: plane of surface itself is orthogonal to user's view direction.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
|
| parallelColor |
[parallelColor accessType inputOutput, type SFColorRGBA CDATA "0 0 0 1"] [0,1]
parallelColor is used for surface normals that are orthogonal to viewer's current location.
Hint: plane of surface itself is parallel to user's view direction.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
|
| containerField |
[containerField type NMTOKEN "renderStyle"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Circle2D |
[inherits X3DGeometryNode]
Circle2D is a geometry node that defines a linear X-Y circle with center (0,0) in X-Y plane.
Hint: insert a Shape node before adding geometry or Appearance.
Warning: requires X3D profile='Full' or else include <component name='Geometry2D' level='2'/>
Examples: X3D Example Archives, X3D for Web Authors, Chapter 10 Geometry 2D https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter10Geometry2D |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| radius |
[radius accessType initializeOnly, type SFFloat CDATA "1"] (0,+∞)
circle radius.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
|
| containerField |
[containerField type NMTOKEN "geometry"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
ClipPlane |
(X3D version 3.2 or later) [inherits X3DChildNode]
ClipPlane specifies a single plane equation used to clip (i.e. cull or hide) displayed geometry. The plane field specifies
a four-component plane equation that describes both inside and outside half space.
Hint: ClipPlane nodes only affect peer and descendant nodes, thus a parent grouping node can limit its effect.
Warning: requires X3D profile='Full' or else include <component name='Rendering' level='5'/>
Examples: X3D Example Archives, Basic, CAD, Clip Plane Example https://www.web3d.org/x3d/content/examples/Basic/CAD/ClipPlaneExampleIndex.html |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| plane |
[plane accessType inputOutput, type SFVec4f CDATA "0 1 0 0"] [0,1]
If (a,b,c,d) is the plane, with the first three components being a normalized vector describing the plane's normal direction
(and thus the fourth component d being distance from the origin), a point (x,y,z) is visible to the user, with regards to
the clipping plane, if a*x+b*y+c*z+d is greater than 0.
Warning: (a, b, c) value of (0, 0, 0) is forbidden since the zero vector has ambiguous direction and is thus degenerate, not defining
a plane.
Hint: negate all plane values to reverse which side of plane has visibility clipped.
Hint: plane-geometry equations http://en.wikipedia.org/wiki/Plane_(geometry)#Point-normal_form_and_general_form_of_the_equation_of_a_plane
Hint: plane-geometry distance to point http://en.wikipedia.org/wiki/Plane_(geometry)#Distance_from_a_point_to_a_plane
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
CollidableOffset |
(X3D version 3.2 or later) [inherits X3DNBodyCollidableNode]
CollidableOffset repositions geometry relative to center of owning body.
Contains a single CollidableShape or CollidableOffset node (containerField='collidable'). |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| translation |
[translation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position (x, y, z in meters) of children relative to local coordinate system.
Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the
center offset, then translation.
|
| rotation |
[rotation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Orientation (axis, angle in radians) of children relative to local coordinate system.
Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the
center offset, then translation.
|
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local
coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"]
Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time
with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization
or constraint.
Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
CollidableShape |
(X3D version 3.2 or later) [inherits X3DNBodyCollidableNode]
CollidableShape connects the collision detection system, the rigid body model, and the renderable scene graph.
Contains a single Shape node (containerField='shape') for animating collidable geometry.
Warning: avoid changing Shape geometry at run time to prevent performance problems.
Warning: apply containerField='shape' to single Shape child node, not containerField='children' default. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| translation |
[translation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position (x, y, z in meters) of children relative to local coordinate system.
Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the
center offset, then translation.
|
| rotation |
[rotation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Orientation (axis, angle in radians) of children relative to local coordinate system.
Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the
center offset, then translation.
|
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local
coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"]
Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time
with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization
or constraint.
Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Collision |
[inherits X3DGroupingNode, implements X3DSensorNode]
Collision detects camera-to-object contact using current view and NavigationInfo avatarSize.
Collision is a Grouping node that reports collision detection for its children.
Hint: Collision can contain a single proxy child node for substitute collision-detection geometry. Improve run-time performance
by using proxy with simpler contact-calculation geometry.
Hint: proxy shapes are not rendered and remain invisible.
Hint: apply containerField='proxy' to uniquely identify the proxy child Shape or grouping node.
Warning: PointSet, IndexedLineSet, LineSet and Text are not collidable geometry do not trigger collisions.
Hint: NavigationInfo types '"WALK" "FLY"' support camera-to-object collision detection.
Hint: insert a Shape node before adding geometry or Appearance. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DChildNode]
Grouping nodes contain an ordered list of children nodes.
Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus
transformations accumulate down the scene graph hierarchy.
Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e.
matching DEF, USE values) are ignored.
Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching
DEF, USE values) are ignored.
Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
|
| proxy |
[proxy accessType inputOutput, type SFNode singleton, NULL node] [X3DChildNode]
The proxy node is used as a substitute for Collision children during collision detection, simplifying collision-intersection
computations.
Hint: The proxy node is used strictly for collision detection and is not drawn.
Warning: the proxy node must have containerField='proxy' or it is simply treated like other children nodes.
Warning: insert a Shape node before adding geometry or Appearance.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local
coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"]
Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time
with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization
or constraint.
Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables collision detection for children and all descendants.
Hint: former name "collide" in VRML97 specification.
|
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when triggering the sensor. isActive=true when view-object collision occurs, isActive=false
when view-object collision no longer occurs.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| collideTime |
[collideTime accessType outputOnly, type SFTime CDATA #FIXED ""]
Time of collision between camera (avatar) and geometry.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
CollisionCollection |
(X3D version 3.2 or later) [inherits X3DChildNode]
CollisionCollection holds a collection of objects that can be managed as a single entity for resolution of inter-object
collisions.
Hint: contains an array of CollisionSpace, CollidableShape or CollidableOffset nodes (containerField='collidables'). |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| collidables |
[collidables accessType inputOutput, type MFNode array, empty list] [CollisionSpace | CollidableShape | CollidableOffset]
CollisionCollection node holds a collection of objects in the collidables field that can be managed as a single entity for
resolution of inter-object collisions with other groups of collidable objects. A group consists of both collidable objects
as well as spaces that may be collided against each other.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| appliedParameters |
[appliedParameters accessType inputOutput, type MFString CDATA "BOUNCE"]
Default global parameters for collision outputs of rigid body physics system. Contact node can override parent CollisionCollection
node. Selectable values for array: "BOUNCE" "USER_FRICTION" "FRICTION_COEFFICIENT-2" "ERROR_REDUCTION" "CONSTANT_FORCE" "SPEED-1"
"SPEED-2" "SLIP-1" "SLIP-2".
Hint: BOUNCE: bounce value is used; USER_FRICTION: apply user-supplied value; FRICTION_COEFFICIENT-2: apply frictionCoefficients
values; ERROR_REDUCTION: apply softnessErrorCorrection value; CONSTANT_FORCE: apply softnessConstantForceMix value; SPEED-1:
apply first component of surfaceSpeed array; SPEED-2: apply second component of surfaceSpeed array; SLIP-1: apply first component
of slipFactors array; SLIP-2: apply second component of slipFactors array.
|
| bounce |
[bounce accessType inputOutput, type SFFloat CDATA "0"] [0,1]
bounce indicates bounciness (0 = no bounce at all, 1 = maximum bounce).
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| frictionCoefficients |
[frictionCoefficients accessType inputOutput, type SFVec2f CDATA "0 0"]
frictionCoefficients used for computing surface drag.
|
| minBounceSpeed |
[minBounceSpeed accessType inputOutput, type SFFloat CDATA "0"] [0,+∞)
minBounceSpeed m/s needed to bounce.
|
| slipFactors |
[slipFactors accessType inputOutput, type SFVec2f CDATA "0 0"]
slipFactors used for computing surface drag.
|
| softnessConstantForceMix |
[softnessConstantForceMix accessType inputOutput, type SFFloat CDATA "0"] [0,1]
softnessConstantForceMix value applies a constant force value to make colliding surfaces appear to be somewhat soft.
|
| softnessErrorCorrection |
[softnessErrorCorrection accessType inputOutput, type SFFloat CDATA "0"] [0,1]
softnessErrorCorrection indicates fraction of collision error fixed in a set of evaluations (0 = no error correction, 1
= all errors corrected in single step).
|
| surfaceSpeed |
[surfaceSpeed accessType inputOutput, type SFVec2f CDATA "0 0"]
surfaceSpeed defines speed vectors for computing surface drag, if contact surfaces move independently of bodies.
|
| containerField |
[containerField type NMTOKEN "collider"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
CollisionSensor |
(X3D version 3.2 or later) [inherits X3DSensorNode]
CollisionSensor generates collision-detection events.
Hint: contains CollisionCollection node (containerField='collider').
Hint: CollisionSensor also has output events: CollidableOffset and CollidableShape nodes (containerField='intersections'), Contact
nodes (containerField='contacts').
Hint: event timing details are explained in X3D Specification 4.4.8.3 Execution model https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#ExecutionModel |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when sensing starts/stops.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
CollisionSpace |
(X3D version 3.2 or later) [inherits X3DNBodyCollisionSpaceNode]
CollisionSpace holds collection of objects considered together for resolution of inter-object collisions.
Contains multiple CollidableShape, CollidableOffset, or CollisionSpace nodes (containerField='collidables'). |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| useGeometry |
[useGeometry accessType inputOutput, type SFBool (true|false) "false"]
useGeometry indicates whether collision-detection code checks down to level of geometry, or only make approximations using
geometry bounds.
Hint: testing against object bounds is usually sufficient.
Warning: using geometry is more accurate but slower.
|
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local
coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"]
Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time
with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization
or constraint.
Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with
a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Color |
[inherits X3DColorNode]
Color node defines a set of RGB color values that apply either to a sibling Coordinate|CoordinateDouble node, or else to
a parent ElevationGrid node.
Color is only used by ElevationGrid, IndexedFaceSet, IndexedLineSet, LineSet, PointSet, Triangle* and IndexedTriangle* nodes.
Hint: colors are often controlled by Material instead.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| color |
[color accessType inputOutput, type MFColor CDATA #IMPLIED]
The color field defines an array of 3-tuple RGB colors.
|
| containerField |
[containerField type (color | colorRamp) "color"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
ColorChaser |
(X3D version 3.3 or later) [inherits X3DChaserNode]
ColorChaser generates a series of SFColor values that progressively change from initial value to destination value.
Hint: ROUTE value_changed output events to one of a <Material> node's color fields, for example.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| duration |
[duration accessType inputOutput, type SFTime CDATA "1"] [0,+∞)
duration is the time interval for filter response in seconds.
Hint: duration is a nonnegative SFTime duration interval, not an absolute clock time.
|
| initialValue |
[initialValue accessType initializeOnly, type SFColor CDATA "0.8 0.8 0.8"]
Initial starting value for this node.
|
| initialDestination |
[initialDestination accessType initializeOnly, type SFColor CDATA "0.8 0.8 0.8"]
Initial destination value for this node.
|
| set_value |
[set_value accessType inputOnly, type SFColor CDATA #FIXED ""]
set_value resets current value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| set_destination |
[set_destination accessType inputOnly, type SFColor CDATA #FIXED ""]
set_destination resets destination value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when follower-node computation starts/stops.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| value_changed |
[value_changed accessType outputOnly, type SFColor CDATA #FIXED ""]
Computed output value that approaches within tolerance of destination value, as determined by elapsed time, order and tau.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
ColorDamper |
(X3D version 3.2 or later) [inherits X3DDamperNode]
ColorDamper generates a series of RGB color values that progressively change from initial value to destination value.
Hint: ROUTE value_changed output events to one of a <Material> node's color fields, for example.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| order |
[order accessType initializeOnly, type SFInt32 CDATA "3"] [0,5]
order defines the number of internal filters (larger means smoother response, longer delay).
|
| tau |
[tau accessType inputOutput, type SFTime CDATA "0.3"] [0,+∞)
tau is the exponential-decay time constant for filter response in seconds.
|
| tolerance |
[tolerance accessType inputOutput, type SFFloat CDATA #IMPLIED] [0,+∞)
or -1. Absolute value for satisfactory completion proximity (-1 lets browser choose).
|
| initialValue |
[initialValue accessType initializeOnly, type SFColor CDATA "0.8 0.8 0.8"]
Initial starting value for this node.
|
| initialDestination |
[initialDestination accessType initializeOnly, type SFColor CDATA "0.8 0.8 0.8"]
Initial destination value for this node.
|
| set_value |
[set_value accessType inputOnly, type SFColor CDATA #FIXED ""]
set_value resets current value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| set_destination |
[set_destination accessType inputOnly, type SFColor CDATA #FIXED ""]
set_destination resets destination value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when follower-node computation starts/stops.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| value_changed |
[value_changed accessType outputOnly, type SFColor CDATA #FIXED ""]
Computed output value that approaches within tolerance of destination value, as determined by elapsed time, order and tau.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
ColorInterpolator |
[inherits X3DInterpolatorNode]
ColorInterpolator generates a range of color values. Authors can ROUTE value_changed output events to various color fields
of Material or Color nodes.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction.
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| key |
[key accessType inputOutput, type MFFloat CDATA #IMPLIED]
Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to
a value in the keyValue array.
Warning: number of keys must match number of keyValues!
Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding
value.
Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
|
| keyValue |
[keyValue accessType inputOutput, type MFColor CDATA #IMPLIED]
Output values for linear interpolation, each corresponding to an input-fraction value in the key array.
Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. https://en.wikipedia.org/wiki/Step_function
Warning: number of keys must match number of keyValues!
|
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input key for corresponding keyValue output.
Hint: set_fraction values are typically in same range interval as values in the key array. Response to an input set_fraction value
less than minimum is equivalent to minimum key, and response to an input set_fraction value greater than maximum is equivalent
to maximum key.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| value_changed |
[value_changed accessType outputOnly, type SFColor CDATA #FIXED ""]
Linearly interpolated output value determined by current key time and corresponding keyValue pair.
Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive superfluous events that have no effect.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
ColorRGBA |
[inherits X3DColorNode]
ColorRGBA node defines a set of RGBA color values that apply either to a sibling Coordinate|CoordinateDouble node, or else
to a parent ElevationGrid node.
ColorRGBA is only used by ElevationGrid, IndexedFaceSet, IndexedLineSet, LineSet, PointSet, Triangle* and IndexedTriangle*
nodes.
Hint: colors are often controlled by Material instead.
Hint: alpha channel may be ignored under Interchange profile.
Warning: ColorRGBA requires Rendering component level 3 (alpha fully supported), Rendering component level 1 (alpha optional), otherwise
Full profile.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| color |
[color accessType inputOutput, type MFColorRGBA CDATA #IMPLIED] [0,1]
The color field defines an array of 4-tuple RGBA colors.
Warning: ColorRGBA requires Rendering component level 3 (alpha fully supported), Rendering component level 1 (alpha optional), otherwise
Full profile.
|
| containerField |
[containerField type (color | colorRamp) "color"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
component |
[X3D statement]
Each added component statement indicates needed scene functionality above the given X3D profile.
Hint: component statements are optional secondary children of head statement (add a head statement first).
Hint: X3D XML Encoding https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#Header
Warning: the COMPONENT statement is capitalized in the X3D Architecture specification and in the X3D ClassicVRML Encoding.
Hint: X3D Architecture 7.2.5.4 COMPONENT statement https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#COMPONENTStatement |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| name |
[name type ENUMERATION #REQUIRED (Core | CADGeometry | CubeMapTexturing | DIS | EnvironmentalEffects | EnvironmentalSensor | EventUtilities | Followers |
Geometry2D | Geometry3D | Geospatial | Grouping | H-Anim | Interpolation | KeyDeviceSensor | Layering | Layout | Lighting
| Navigation | Networking | NURBS | ParticleSystems | Picking | PointingDeviceSensor | Rendering | RigidBodyPhysics | Scripting
| Shaders | Shape | Sound | Text | Texturing | Texturing3D | Time)]
Provides name of this component, as defined in corresponding X3D Specification component Introduction.
Example: X3D Architecture 10.1.1 Name for Grouping component https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#Name
Hint: all nodes, components and levels are already supported in Full profile.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| level |
[level type SFInt32 #REQUIRED (1|2|3|4|5)]
Necessary level of support for this scene, as defined in corresponding Support table for a given node's component.
Hint: for example specification definitions, X3D Architecture Grouping component, 10.5 Support levels https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#SupportLevels
|
| |
accessType and type Credits and Translations X3D Resources |
ComposedCubeMapTexture |
(X3D version 3.1 or later) [inherits X3DEnvironmentTextureNode]
ComposedCubeMapTexture is a texture node that defines a cubic environment map source
as an explicit set of images drawn from individual 2D texture nodes.
Hint: 0..6 child image nodes are allowed (ImageTexture MovieTexture PixelTexture) with corresponding containerField values: front
back left right top bottom.
Warning: each of the child ImageTexture or PixelTexture nodes must have unique containerField values for back, bottom, front, left,
right, or top. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| containerField |
[containerField type NMTOKEN "texture"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
ComposedShader |
(X3D version 3.1 or later) [inherits X3DShaderNode, implements X3DProgrammableShaderObject]
ComposedShader defines a shader where the individual source files are assembled from contained ShaderPart program sections.
All access to shading capabilities is defined through a single interface that applies to all parts.
Hint: ComposedShader contains field declarations and then corresponding IS/connect statements (if any when defining inside a ProtoBody),
followed by <ShaderPart containerField='parts'/> nodes.
Warning: ComposedShader does not contain CDATA section of plain-text source code. All source programs are contained in child ShaderPart
nodes.
Hint: apply default containerField='shaders' when parent node is Appearance. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| field |
[X3D statement field]
Include a field statement for each field declaration in the ComposedShader node.
|
| parts |
[parts accessType inputOutput, type MFNode array, empty list] [ShaderPart]
ComposedShader can contain multiple ShaderPart nodes in the parts field.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| activate |
[activate accessType inputOnly, type SFBool (true|false)]
activate forces the shader to activate the contained objects.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| isSelected |
[isSelected accessType outputOnly, type SFBool (true|false)]
isSelected indicates this shader instance is selected for use by browser
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| isValid |
[isValid accessType outputOnly, type SFBool (true|false)]
isValid indicates whether current shader objects can be run as a shader program.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| language |
[language accessType initializeOnly, type SFString CDATA #IMPLIED]
The language field indicates to the X3D player which shading language is used. The language field may be used to optionally
determine the language type if no MIME-type information is available.
Hint: recognized values include "Cg" "GLSL" "HLSL".
|
| containerField |
[containerField type NMTOKEN "shaders"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
ComposedTexture3D |
(X3D version 3.1 or later) [inherits X3DTexture3DNode]
ComposedTexture3D defines a 3D image-based texture map as a collection of 2D texture sources at various depths.
Hint: insert 2^n ImageTexture, PixelTexture or MovieTexture child nodes.
The first image is at depth 0 and each following image is at an increasing depth value in the R direction.
Hint: can contain a single TextureProperties node.
Hint: insert Shape and Appearance nodes before adding texture.
Hint: X3D Architecture 33.2.2 3D texturing concepts https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texture3D.html#3DTextureconcepts |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| repeatS |
[repeatS accessType initializeOnly, type SFBool (true|false) "false"]
Whether to horizontally repeat texture along S axis.
|
| repeatT |
[repeatT accessType initializeOnly, type SFBool (true|false) "false"]
Whether to vertically repeat texture along T axis.
|
| repeatR |
[repeatR accessType initializeOnly, type SFBool (true|false) "false"]
Whether to vertically repeat texture along R axis.
|
| containerField |
[containerField type NMTOKEN "texture"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
ComposedVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
ComposedVolumeStyle allows compositing multiple rendering styles into single rendering pass.
Hint: contains multiple RenderStyle nodes. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| renderStyle |
[renderStyle accessType inputOutput, type MFNode array, empty list] [X3DComposableVolumeRenderStyleNode]
List of contributing rendering style nodes or node references that can be applied to the object. Each rendering style is
applied strictly in the order declared, starting with the first rendering style in the renderStyle field.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| ordered |
[ordered accessType inputOutput, type SFBool (true|false) "false"]
If ordered is true, strictly apply each contained renderStyle node in order declared.
|
| containerField |
[containerField type NMTOKEN "renderStyle"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Cone |
[inherits X3DGeometryNode]
Cone is a geometry node.
Hint: cone https://en.wikipedia.org/wiki/Cone
Hint: insert a Shape node before adding geometry or Appearance. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| height |
[height accessType initializeOnly, type SFFloat CDATA "2"] (0,+∞)
Size in meters.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
|
| bottomRadius |
[bottomRadius accessType initializeOnly, type SFFloat CDATA "1"] (0,+∞)
Size in meters.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
|
| side |
[side accessType initializeOnly, type SFBool (true|false) "true"]
Whether to draw sides (other inside faces are not drawn).
Warning: cannot be changed after initial creation.
|
| bottom |
[bottom accessType initializeOnly, type SFBool (true|false) "true"]
Whether to draw bottom (other inside faces are not drawn).
Warning: cannot be changed after initial creation.
|
| solid |
[solid accessType initializeOnly, type SFBool (true|false) "true"]
Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides
of polygons (backface culling off).
Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
Warning: default value true can completely hide geometry if viewed from wrong side!
Hint: if in doubt, use solid='false' for maximum visibility.
Warning: solid false not supported in VRML97.
|
| containerField |
[containerField type NMTOKEN "geometry"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
ConeEmitter |
(X3D version 3.2 or later) [inherits X3DParticleEmitterNode]
ConeEmitter generates all available particles from a specific point in space. Particles are emitted from the single point
specified by the position field emanating in a direction randomly distributed within the cone specified by the angle and direction
fields. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| angle |
[angle accessType inputOutput, type SFFloat CDATA "0"] [0,+∞)
Cone boundary for random distribution of particles about initial direction.
Hint: https://en.wikipedia.org/wiki/Radian
|
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 1 0"]
Initial direction from which particles emanate.
|
| position |
[position accessType inputOutput, type SFVec3f CDATA "0 1 0"]
Point from which particles emanate.
|
| speed |
[speed accessType inputOutput, type SFFloat CDATA "0"] [0,+∞)
Initial linear speed (default is m/s) imparted to all particles along their direction of movement.
|
| surfaceArea |
[surfaceArea accessType initializeOnly, type SFFloat CDATA "0"] [0,+∞)
Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind
effects per particle.
Hint: surfaceArea value represents average frontal area presented to the wind.
Hint: assumes spherical model for each particle (i.e., surface area is the same regardless of direction).
|
| variation |
[variation accessType inputOutput, type SFFloat CDATA "0.25"] [0,+∞)
Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random
the output and the bigger the range of possible initial values possible.
Hint: variation of zero does not allow any randomness.
|
| containerField |
[containerField type NMTOKEN "emitter"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
connect |
[X3D statement]
connect statements define event-routing connections between node fields defined inside a ProtoBody declaration back to corresponding
ProtoInterface fields. To define each Prototype connection between a ProtoInterface field and a ProtoBody node field, add
one or more connect statements within each IS statement.
Warning: IS/connect elements are only allowed within ProtoDeclare body definitions.
Warning: nodeField and protoField types must match.
Hint: any matching field type can be connected, including SFNode or MFNode.
Hint: see the IS and ProtoBody statements.
Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#PROTOdefinitionsemantics
Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter14Prototypes |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| nodeField |
[nodeField type NMTOKEN #REQUIRED]
Name of field within this node which IS CONNECTed to the ancestor ProtoDeclare field definition.
Warning: do not define a nodeField connection to an internal DEF, USE, class or containerField, since they are not fields in a node
that can be modified by events at run time.
Warning: do not connect more than one interface protoField to a single field within this node.
Warning: nodeField and protoField types must match.
|
| protoField |
[protoField type NMTOKEN #REQUIRED]
Name of parent ProtoDeclare field definition connecting to field in this node.
Hint: use multiple IS/connect elements for multiple fan-out from a single protoField interface.
Warning: nodeField and protoField types must match.
|
| |
accessType and type Credits and Translations X3D Resources |
|
Contact |
(X3D version 3.2 or later) [inherits X3DNode]
Contact nodes are produced as output events when two collidable objects or spaces make contact.
Hint: each Contact node contains two RigidBody nodes (containerField='body1' and containerField='body2') as well as two CollidableShape
or CollidableOffset nodes (containerField='geometry1' and containerField='geometry2').
Warning: Contact nodes are transient and can only occur at run time. It is an error to define this transient node in an X3D file.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| appliedParameters |
[appliedParameters accessType inputOutput, type MFString CDATA "BOUNCE"]
Default global parameters for collision outputs of rigid body physics system. Contact node can override parent CollisionCollection
node. Selectable values for array: "BOUNCE" "USER_FRICTION" "FRICTION_COEFFICIENT-2" "ERROR_REDUCTION" "CONSTANT_FORCE" "SPEED-1"
"SPEED-2" "SLIP-1" "SLIP-2".
Hint: BOUNCE: bounce value is used; USER_FRICTION: apply user-supplied value; FRICTION_COEFFICIENT-2: apply frictionCoefficients
values; ERROR_REDUCTION: apply softnessErrorCorrection value; CONSTANT_FORCE: apply softnessConstantForceMix value; SPEED-1:
apply first component of surfaceSpeed array; SPEED-2: apply second component of surfaceSpeed array; SLIP-1: apply first component
of slipFactors array; SLIP-2: apply second component of slipFactors array.
|
| bounce |
[bounce accessType inputOutput, type SFFloat CDATA "0"] [0,1]
bounce indicates bounciness (0 = no bounce at all, 1 = maximum bounce).
|
| contactNormal |
[contactNormal accessType inputOutput, type SFVec3f CDATA "0 1 0"]
contactNormal is unit vector describing normal between two colliding bodies.
|
| depth |
[depth accessType inputOutput, type SFFloat CDATA "0"] [0,1]
depth indicates how deep the current intersection is along normal vector.
|
| frictionCoefficients |
[frictionCoefficients accessType inputOutput, type SFVec2f CDATA "0 0"]
frictionCoefficients used for computing surface drag.
|
| frictionDirection |
[frictionDirection accessType inputOutput, type SFVec3f CDATA "0 1 0"]
frictionDirection controls friction vector.
Hint: value of (0 0 0) indicates no friction.
|
| minBounceSpeed |
[minBounceSpeed accessType inputOutput, type SFFloat CDATA "0"] [0,+∞)
minBounceSpeed m/s needed to bounce.
|
| position |
[position accessType inputOutput, type SFVec3f CDATA "0 0 10"]
position (x, y, z in meters) of exact location of collision.
|
| slipCoefficients |
[slipCoefficients accessType inputOutput, type SFVec2f CDATA "0 0"]
slipCoefficients used for computing surface drag.
|
| softnessConstantForceMix |
[softnessConstantForceMix accessType inputOutput, type SFFloat CDATA "0"] [0,1]
softnessConstantForceMix value applies a constant force value to make colliding surfaces appear to be somewhat soft.
|
| softnessErrorCorrection |
[softnessErrorCorrection accessType inputOutput, type SFFloat CDATA "0"] [0,1]
softnessErrorCorrection indicates fraction of collision error fixed in a set of evaluations (0 = no error correction, 1
= all errors corrected in single step).
|
| surfaceSpeed |
[surfaceSpeed accessType inputOutput, type SFVec2f CDATA "0 0"]
surfaceSpeed defines speed vectors for computing surface drag, if contact surfaces move independently of bodies.
|
| containerField |
[containerField type NMTOKEN "contacts"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Contour2D |
[inherits X3DNode]
Contour2D groups a set of curve segments into a composite contour.
The children segments form a closed loop, with first point of first child repeated as last point of last child, and last point
of each segment repeated as the first point of the next consecutive segment.
The children segments are type NurbsCurve2D or ContourPolyline2D, enumerated in the consecutive order of contour topology.
Warning: Contour2D is not a renderable geometry node.
Hint: Contour2D is used as the trimmingContour field of the NurbsTrimmedSurface node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| children |
[children accessType inputOutput, type MFNode array, empty list] [NurbsCurve2D | ContourPolyline2D]
The children form a closed loop with first point of first child repeated as last point of last child, and the last point
of a segment repeated as first point of the consecutive one.
Hint: children nodes are listed in consecutive order according to topology of the contour.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| containerField |
[containerField type NMTOKEN "trimmingContour"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
ContourPolyline2D |
[inherits X3DNurbsControlCurveNode]
ContourPolyline2D defines a linear curve segment as part of a trimming contour in the u-v domain of a NURBS surface. NurbsCurve2D
and ContourPolyline2D nodes that together form a closed contour, defined in the u-v parametric space of a NURBS surface, may
be used as children in a Contour2D node.
Warning: ContourPolyline2D is not a renderable geometry node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| controlPoint |
[controlPoint accessType inputOutput, type MFVec2d CDATA #IMPLIED]
controlPoint specifies the end points of each segment of the piecewise linear curve.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Coordinate |
[inherits X3DCoordinateNode]
Coordinate builds geometry by defining a set of 3D coordinate (triplet) point values.
Coordinate is used by IndexedFaceSet, IndexedLineSet, LineSet, PointSet, Triangle* and IndexedTriangle* nodes.
Coordinate is also used by HAnimHumanoid, HAnimSegment, and various Nurbs nodes. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| point |
[point accessType inputOutput, type MFVec3f CDATA #IMPLIED]
point contains a set of 3D coordinate (triplet) point values.
|
| containerField |
[containerField type NMTOKEN (coord | controlPoint | skinCoord | skinBindingCoords) "coord"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
CoordinateChaser |
(X3D version 3.3 or later) [inherits X3DChaserNode]
CoordinateChaser generates a series of coordinate arrays that progressively change from initial value to destination value.
Hint: ROUTE value_changed output events to a <Coordinate> node's point field, for example. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| duration |
[duration accessType inputOutput, type SFTime CDATA "1"] [0,+∞)
duration is the time interval for filter response in seconds.
Hint: duration is a nonnegative SFTime duration interval, not an absolute clock time.
|
| initialValue |
[initialValue accessType initializeOnly, type MFVec3f CDATA "0 0 0"]
Initial starting value for this node.
|
| initialDestination |
[initialDestination accessType initializeOnly, type MFVec3f CDATA "0 0 0"]
Initial destination value for this node.
|
| set_value |
[set_value accessType inputOnly, type MFVec3f CDATA #FIXED ""]
set_value resets current value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| set_destination |
[set_destination accessType inputOnly, type MFVec3f CDATA #FIXED ""]
set_destination resets destination value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when follower-node computation starts/stops.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| value_changed |
[value_changed accessType outputOnly, type MFVec3f CDATA #FIXED ""]
Computed output value that approaches within tolerance of destination value, as determined by elapsed time, order and tau.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
CoordinateDamper |
(X3D version 3.2 or later) [inherits X3DDamperNode]
CoordinateDamper generates a series of coordinate arrays that progressively change from initial value to destination value.
Hint: ROUTE value_changed output events to a <Coordinate> node's point field, for example. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| order |
[order accessType initializeOnly, type SFInt32 CDATA "3"] [0,5]
order defines the number of internal filters (larger means smoother response, longer delay).
|
| tau |
[tau accessType inputOutput, type SFTime CDATA "0.3"] [0,+∞)
tau is the exponential-decay time constant for filter response in seconds.
|
| tolerance |
[tolerance accessType inputOutput, type SFFloat CDATA #IMPLIED] [0,+∞)
or -1. Absolute value for satisfactory completion proximity (-1 lets browser choose).
|
| initialValue |
[initialValue accessType initializeOnly, type MFVec3f CDATA "0 0 0"]
Initial starting value for this node.
|
| initialDestination |
[initialDestination accessType initializeOnly, type MFVec3f CDATA "0 0 0"]
Initial destination value for this node.
|
| set_value |
[set_value accessType inputOnly, type MFVec3f CDATA #FIXED ""]
set_value resets current value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| set_destination |
[set_destination accessType inputOnly, type MFVec3f CDATA #FIXED ""]
set_destination resets destination value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when follower-node computation starts/stops.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| value_changed |
[value_changed accessType outputOnly, type MFVec3f CDATA #FIXED ""]
Computed output value that approaches within tolerance of destination value, as determined by elapsed time, order and tau.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
|
CoordinateDouble |
[inherits X3DCoordinateNode]
CoordinateDouble builds geometry by defining a set of 3D coordinate (triplet) point values.
CoordinateDouble is used by IndexedFaceSet, IndexedLineSet, LineSet, PointSet, Triangle* and IndexedTriangle* nodes.
CoordinateDouble is also used by NurbsPositionInterpolator and NurbsOrientationInterpolator.
Warning: CoordinateDouble requires NURBS component level 1, otherwise Full profile. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| point |
[point accessType inputOutput, type MFVec3d CDATA #IMPLIED]
point contains a set of 3D coordinate (triplet) point values.
|
| containerField |
[containerField type NMTOKEN (coord | controlPoint | skinCoord | skinBindingCoords) "coord"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
CoordinateInterpolator |
[inherits X3DInterpolatorNode]
CoordinateInterpolator linearly interpolates among a list of 3-tuple MFVec3f arrays, producing a single MFVec3f array that
is fractional average between two nearest arrays in the list. Authors can ROUTE value_changed output events (an array of 3-tuple
SFVec3f values) to a Coordinate node's point field, or to another MFVec3f field.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction.
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| key |
[key accessType inputOutput, type MFFloat CDATA #IMPLIED]
Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to
a value in the keyValue array.
Hint: number of keyValues must be an integer multiple of the number of keys!
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys.
Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding
value.
Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
|
| keyValue |
[keyValue accessType inputOutput, type MFVec3f CDATA #IMPLIED]
Output values for linear interpolation, each corresponding to an input-fraction value in the key array.
Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. https://en.wikipedia.org/wiki/Step_function
Hint: number of keyValues must be an integer multiple of the number of keys!
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys.
|
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input key for corresponding keyValue output.
Hint: set_fraction values are typically in same range interval as values in the key array. Response to an input set_fraction value
less than minimum is equivalent to minimum key, and response to an input set_fraction value greater than maximum is equivalent
to maximum key.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| value_changed |
[value_changed accessType outputOnly, type MFVec3f CDATA #FIXED ""]
Linearly interpolated output value determined by current key time and corresponding keyValue pair.
Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive superfluous events that have no effect.
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
CoordinateInterpolator2D |
[inherits X3DInterpolatorNode]
CoordinateInterpolator2D generates a series of SFVec2f or MFVec2f 2-tuple float values. Authors can ROUTE value_changed
output events to a SFVec2f or MFVec2f attribute.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction.
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='3'/> |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| key |
[key accessType inputOutput, type MFFloat CDATA #IMPLIED]
Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to
a value in the keyValue array.
Hint: number of keyValues must be an integer multiple of the number of keys!
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys.
Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding
value.
Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
|
| keyValue |
[keyValue accessType inputOutput, type MFVec2f CDATA #IMPLIED]
Output values for linear interpolation, each corresponding to an input-fraction value in the key array.
Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. https://en.wikipedia.org/wiki/Step_function
Hint: number of keyValues must be an integer multiple of the number of keys!
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys.
|
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input key for corresponding keyValue output.
Hint: set_fraction values are typically in same range interval as values in the key array. Response to an input set_fraction value
less than minimum is equivalent to minimum key, and response to an input set_fraction value greater than maximum is equivalent
to maximum key.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| value_changed |
[value_changed accessType outputOnly, type MFVec2f CDATA #FIXED ""]
Linearly interpolated output value determined by current key time and corresponding keyValue pair.
Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive superfluous events that have no effect.
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Cylinder |
[inherits X3DGeometryNode]
Cylinder is a geometry node.
Hint: Cylinder https://en.wikipedia.org/wiki/Cylinder
Hint: insert a Shape node before adding geometry or Appearance. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| height |
[height accessType initializeOnly, type SFFloat CDATA "2"] (0,+∞)
Size in meters.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
|
| radius |
[radius accessType initializeOnly, type SFFloat CDATA "1"] (0,+∞)
Size in meters.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
|
| top |
[top accessType initializeOnly, type SFBool (true|false) "true"]
Whether to draw top (inside faces are never drawn).
Warning: cannot be changed after initial creation.
|
| side |
[side accessType initializeOnly, type SFBool (true|false) "true"]
Whether to draw sides (inside faces are never drawn).
Warning: cannot be changed after initial creation.
|
| bottom |
[bottom accessType initializeOnly, type SFBool (true|false) "true"]
Whether to draw bottom (inside faces are never drawn).
Warning: cannot be changed after initial creation.
|
| solid |
[solid accessType initializeOnly, type SFBool (true|false) "true"]
Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides
of polygons (backface culling off).
Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
Warning: default value true can completely hide geometry if viewed from wrong side!
Hint: if in doubt, use solid='false' for maximum visibility.
Warning: solid false not supported in VRML97.
|
| containerField |
[containerField type NMTOKEN "geometry"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
CylinderSensor |
[inherits X3DDragSensorNode]
CylinderSensor converts pointer motion (for example, a mouse or wand) into rotation values
using an invisible cylinder aligned with local Y-axis.
Hint: this sensor detects user interactions affecting peer nodes and their child geometry.
Hint: add semi-transparent surrounding geometry to see the effect of the sensor.
Hint: initial relative bearing of pointer drag determines whether
cylinder sides or end-cap disks are used for manipulation.
Hint: X3D Architecture 20.2.1 Overview of pointing device sensors https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/pointingsensor.html#OverviewOfPointingDeviceSensors
Hint: X3D Architecture 20.2.2 Drag sensors https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/pointingsensor.html#DragSensors
Hint: X3D Architecture 20.2.3 Activating and manipulating pointing device sensors https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/pointingsensor.html#Activatingandmanipulating |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided text tooltip that tells users the expected action of this node.
Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and
readable.
Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value
(such as & for & ampersand character, or " for " quotation-mark character).
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| minAngle |
[minAngle accessType inputOutput, type SFFloat CDATA "0"]
clamps rotation_changed events within range of min/max values
Hint: if minAngle > maxAngle, rotation is not clamped.
Hint: https://en.wikipedia.org/wiki/Radian
|
| maxAngle |
[maxAngle accessType inputOutput, type SFFloat CDATA "0"]
clamps rotation_changed events within range of min/max values
Hint: if minAngle > maxAngle, rotation is not clamped.
Hint: https://en.wikipedia.org/wiki/Radian
|
| diskAngle |
[diskAngle accessType inputOutput, type SFFloat CDATA "0.262" (15 degrees)]
Help decide rotation behavior from initial relative bearing of pointer drag: acute angle whether cylinder sides or end-cap
disks of virtual-geometry sensor are used for manipulation.
Hint: diskAngle 0 forces disk-like behavior, diskAngle 1.570796 (90 degrees) forces cylinder-like behavior.
|
| autoOffset |
[autoOffset accessType inputOutput, type SFBool (true|false) "true"]
determines whether previous offset values are remembered/accumulated.
|
| axisRotation |
[axisRotation accessType inputOutput, type SFRotation CDATA "0 1 0 0"]
axisRotation determines local sensor coordinate system by rotating the local coordinate system.
|
| offset |
[offset accessType inputOutput, type SFFloat CDATA "0"]
Sends event and remembers last value sensed.
Warning: ROUTE connecting rotation_changed to set_offset creates a self-reinforcing positive feedback loop and results in unmanageable
response.
|
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
Select geometry by activating the pointing device (e.g. clicking the mouse) to generate isActive events. Output event isActive=true
is sent when geometry is selected (e.g. when primary mouse button is pressed), output event isActive=false is sent when geometry
is deselected (e.g. when primary mouse button is released).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| isOver |
[isOver accessType outputOnly, type SFBool #FIXED ""]
Hover over geometry by aiming the mouse (or pointing device) to generate isOver events. Sensor sends output event isOver=true
event when pointing device moves over sensor's geometry, and later sends output event isOver=false event when pointing device
moves off.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| rotation_changed |
[rotation_changed accessType outputOnly, type SFRotation CDATA #FIXED ""]
rotation_changed events equal sum of relative bearing changes plus offset value about Y-axis in local coordinate system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| trackPoint_changed |
[trackPoint_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
trackPoint_changed events give intersection point of bearing with sensor's virtual geometry.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
Warning: trackPoint_changed events represent unclamped intersection points on plane surface. Browsers can interpret drags off of
the surface in various ways. Note that translation_changed events are clamped by minPosition/maxPosition and thus may be preferable.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
DirectionalLight |
[inherits X3DLightNode]
DirectionalLight defines parallel light rays that illuminate geometric shapes.
Lighting illuminates all geometry except lines and points. By default, light scope only illuminates peer geometry and children
nodes within the scene graph hierarchy.
No source location is needed since rays are parallel from an infinitely distant source.
DirectionalLight nodes do not attenuate with distance.
Lights have no visible shape themselves and lighting effects continue through any intermediate geometry.
Hint: animate direction to simulate time-of-day sunlight effects.
Hint: the bound NavigationInfo controls whether headlight is enabled on/off.
Interchange profile hint: light might not be scoped by parent Group or Transform. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables this light source.
|
| color |
[color accessType inputOutput, type SFColor CDATA "1 1 1"] [0,1]
color of light, applied to colors of objects.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
|
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 0 -1"]
Orientation vector of light relative to local coordinate system.
Hint: animate direction to simulate time-of-day sunlight effects.
|
| intensity |
[intensity accessType inputOutput, type SFFloat CDATA "1"] [0,1]
Brightness of direct emission from the light.
|
| ambientIntensity |
[ambientIntensity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
Brightness of ambient (nondirectional background) emission from the light.
Interchange profile hint: this field may be ignored, applying the default value regardless.
|
| global |
(X3D version 3.1 or later) [global accessType inputOutput, type SFBool (true|false) "false"]
Global lights illuminate all objects within their volume of lighting influence. Scoped lights only illuminate objects within
the same transformation hierarchy.
Warning: DirectionalLight default global=false to limit scope and avoid inadvertently illuminating every object in a large scene.
PointLight and SpotLight default global=true since their effects are each limited by maximum radius value.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
DISEntityManager |
[inherits X3DChildNode]
DISEntityManager notifies a scene when new DIS ESPDU entities arrive or current entities leave. DISEntityManager may contain
any number of DISEntityTypeMapping nodes that provide a best-match X3D model to incoming entity type values. For each new
DIS entity, DISEntityManager thus produces a new EspduTransform node that contains a corresponding X3D model.
Hint: DISEntityManager contains DISEntityTypeMapping nodes.
Hint: DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
Hint: Savage Developers Guide on DIS https://savage.nps.edu/Savage/developers.html#DIS
Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/> |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| mapping |
[mapping accessType inputOutput, type MFNode array, empty list] [DISEntityTypeMapping]
mapping field provides a mechanism for automatically creating an X3D model when a new entity arrives over the network. If
a new entity matches one of the nodes, an instance of the provided URL is created and added as a child to the EspduTransform
specified in the addedEntities field.
Hint: multiple DISEntityTypeMapping nodes can be provided in mapping field, best match takes precedence
|
| addedEntities |
[addedEntities accessType outputOnly, type MFNode array] [EspduTransform]
addedEntities array contains any new entities added during the last frame.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| removedEntities |
[removedEntities accessType outputOnly, type MFNode array] [EspduTransform]
removedEntities output array provides EspduTransform references to any entities removed during last frame, either due to
a timeout or from an explicit RemoveEntityPDU action.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| address |
[address accessType inputOutput, type SFString CDATA localhost]
Multicast network address, or else "localhost" example: 224.2.181.145.
|
| port |
[port accessType inputOutput, type SFInt32 CDATA "0"]
Multicast network port, for example: 3000.
|
| applicationID |
[applicationID accessType inputOutput, type SFInt32 CDATA "1"]
Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID.
|
| siteID |
[siteID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise siteID of the participating LAN or organization.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
DISEntityTypeMapping |
[inherits X3DInfoNode, implements X3DUrlObject]
DISEntityTypeMapping provides a best-match mapping from DIS ESPDU entity type information to a specific X3D model, thus
providing a visual and behavioral representation that best matches the entity type. Fields are processed in order: kind, domain,
country, category, subcategory, specific, extra.
Hint: values set to zero are wildcards, matching any received value.
Hint: DISEntityTypeMapping is contained by a DISEntityManager node.
Hint: DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
Hint: Savage Developers Guide on DIS https://savage.nps.edu/Savage/developers.html#DIS
Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/>
Hint: apply containerField='watchList' when parent node is LoadSensor. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Local and/or online addresses of X3D model of interest, for example: "ExtrusionExampleShip.x3d" "https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d"
Hint: see https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html
Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems
are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all
case sensitive and intolerant of uppercase/lowercase mismatches.
Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
|
| kind |
[kind accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY,
RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER.
|
| domain |
[domain accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER.
|
| country |
[country accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for country to which the design of the entity or its design specification is attributed.
|
| category |
[category accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for main category that describes the entity, semantics of each code varies according to domain.
See DIS Enumerations values.
|
| subCategory |
[subCategory accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for particular subcategory to which an entity belongs based on the Category field. See DIS Enumerations
values.
|
| specific |
[specific accessType inputOutput, type SFInt32 CDATA "0"]
Specific information about an entity based on the Subcategory field. See DIS Enumerations values.
|
| extra |
[extra accessType inputOutput, type SFInt32 CDATA "0"]
Any extra information required to describe a particular entity. The contents of this field shall depend on the type of entity
represented.
|
| containerField |
[containerField type NMTOKEN (mapping | watchList) "mapping"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
Disk2D |
[inherits X3DGeometryNode]
Disk2D is a geometry node that defines a filled (or partially filled) planar circle with center (0,0).
Hint: insert a Shape node before adding geometry or Appearance.
Warning: requires X3D profile='Full' or else include <component name='Geometry2D' level='2'/>
Examples: X3D Example Archives, X3D for Web Authors, Chapter 10 Geometry 2D https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter10Geometry2D |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| innerRadius |
[innerRadius accessType initializeOnly, type SFFloat CDATA "0"] [0,+∞)
Inner circle radius, greater than or equal to 0.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
|
| outerRadius |
[outerRadius accessType initializeOnly, type SFFloat CDATA "1"] (0,+∞)
Outer radius of circle, greater than or equal to inner radius.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor
Transform scale instead.
|
| solid |
[solid accessType initializeOnly, type SFBool (true|false) "false"]
Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides
of polygons (backface culling off).
Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
Warning: default value true can completely hide geometry if viewed from wrong side!
Hint: if in doubt, use solid='false' for maximum visibility.
Warning: solid false not supported in VRML97.
|
| containerField |
[containerField type NMTOKEN "geometry"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
DoubleAxisHingeJoint |
(X3D version 3.2 or later) [inherits X3DRigidJointNode]
DoubleAxisHingeJoint has two independent axes located around a common anchor point. axis1 has limits and a motor, axis 2
only has a motor
Contains two RigidBody nodes (containerField values body1, body2).
Hint: RigidBodyPhysics component, level 2. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| anchorPoint |
[anchorPoint accessType inputOutput, type SFVec3f CDATA "0 0 0"]
anchorPoint is joint center, specified in world coordinates.
|
| axis1 |
[axis1 accessType inputOutput, type SFVec3f CDATA "0 0 0"]
axis1 defines axis vector of joint connection to body1.
Hint: 0 0 0 means motor disabled.
|
| axis2 |
[axis2 accessType inputOutput, type SFVec3f CDATA "0 0 0"]
axis2 defines axis vector of joint connection to body2.
Hint: 0 0 0 means motor disabled.
|
| desiredAngularVelocity1 |
[desiredAngularVelocity1 accessType inputOutput, type SFFloat CDATA "0"]
desiredAngularVelocity1 is goal rotation rate for hinge connection to body1.
|
| desiredAngularVelocity2 |
[desiredAngularVelocity2 accessType inputOutput, type SFFloat CDATA "0"]
desiredAngularVelocity2 is goal rotation rate for hinge connection to body2.
|
| forceOutput |
[forceOutput accessType inputOutput, type MFString CDATA "NONE"]
forceOutput controls which output fields are generated for the next frame. Values are ALL, NONE, or exact names of output
fields updated at start of next frame.
|
| minAngle1 |
[minAngle1 accessType inputOutput, type SFFloat CDATA "-3.1416"] [-π,π]
minAngle1 is minimum rotation angle for hinge.
|
| maxAngle1 |
[maxAngle1 accessType inputOutput, type SFFloat CDATA "3.1416"] [-π,π]
maxAngle1 is maximum rotation angle for hinge.
|
| maxTorque1 |
[maxTorque1 accessType inputOutput, type SFFloat CDATA "0"]
maxTorque1 is maximum rotational torque applied by corresponding motor axis to achieve desiredAngularVelocity1.
|
| maxTorque2 |
[maxTorque2 accessType inputOutput, type SFFloat CDATA "0"]
maxTorque2 is maximum rotational torque applied by corresponding motor axis to achieve desiredAngularVelocity2.
|
| stop1Bounce |
[stop1Bounce accessType inputOutput, type SFFloat CDATA "0"] [0,1]
stop1Bounce is velocity factor for bounce back once stop point is reached.
Hint: 0 means no bounce, 1 means return velocity matches.
|
| stop1ErrorCorrection |
[stop1ErrorCorrection accessType inputOutput, type SFFloat CDATA "0.8"] [0,1]
stop1ErrorCorrection is fraction of error correction performed during time step once stop point is reached.
Hint: 0 means no error correction, 1 means all error corrected in single step.
|
| stop1ConstantForceMix |
[stop1ConstantForceMix accessType inputOutput, type SFFloat CDATA "0.001"] [0,1]
stop1ConstantForceMix value applies a constant force value to make colliding surfaces appear to be somewhat soft.
Hint: use with suspensionForce to improve softness and numerical stability.
Hint: 0 means no stop adjustment, 1 means springier stop response.
|
| suspensionErrorCorrection |
[suspensionErrorCorrection accessType inputOutput, type SFFloat CDATA "0.8"] [0,1]
suspensionErrorCorrection describes how quickly the system resolves intersection errors due to floating-point inaccuracies.
Hint: use with stop1ConstantForceMix to improve softness and numerical stability.
Hint: 0 means no stop adjustment, 1 means springier stop response.
|
| suspensionForce |
[suspensionForce accessType inputOutput, type SFFloat CDATA "0.8"] [0,1]
suspensionForce describes how quickly the system resolves intersection errors due to floating-point inaccuracies.
Hint: use with stop1ConstantForceMix to improve softness and numerical stability.
Hint: 0 means no stop adjustment, 1 means springier stop response.
|
| containerField |
[containerField type NMTOKEN "joints"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
EaseInEaseOut |
(X3D version 3.2 or later) [inherits X3DNode]
EaseInEaseOut enables gradual animation transitions by modifying TimeSensor fraction outputs.
Output values are modified fractions. Authors can ROUTE value_changed output events to an interpolator, a sequencer, or another
SFFloat attribute.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisEaseInEaseOutDEF.set_fraction
Hint: typical output connection is ROUTE thisEaseInEaseOutDEF.modifiedFraction_changed TO someDestinationNodeDEF.set_fraction.
Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='3'/> |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| key |
[key accessType inputOutput, type MFFloat CDATA #IMPLIED]
Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to
easeInEaseOut array.
Hint: number of keys must be one more than the number of easeInEaseOut values!
Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding
value.
Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
|
| easeInEaseOut |
[easeInEaseOut accessType inputOutput, type MFVec2f CDATA #IMPLIED]
Array of paired values for easeOut fraction and easeIn fraction within each key interval.
Hint: number of easeInEaseOut values must be one less than the number of keys.
|
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input fraction for computation of corresponding easeInEaseOut output value, modifiedFraction_changed.
Hint: set_fraction values are typically in same range interval as values in the key array. Response to an input set_fraction value
less than minimum is equivalent to minimum key, and response to an input set_fraction value greater than maximum is equivalent
to maximum key.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| modifiedFraction_changed |
[modifiedFraction_changed accessType outputOnly, type SFFloat CDATA #FIXED ""]
Interpolated output value determined by current key time, corresponding easeInEaseOut smoothing intervals, and corresponding
key pair.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
EdgeEnhancementVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
EdgeEnhancementVolumeStyle specifies edge enhancement for the volume rendering style.
Hint: surfaceNormals can be provided in a single ComposedTexture3D, ImageTexture3D or PixelTexture3D node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation.
|
| gradientThreshold |
[gradientThreshold accessType inputOutput, type SFFloat CDATA "0.4"] [0,1]
minimum angle (in radians) away from view-direction vector for surface normal before applying enhancement
|
| edgeColor |
[edgeColor accessType inputOutput, type SFColorRGBA CDATA "0 0 0 1"] [0,1]
color used to highlight edges.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
|
| containerField |
[containerField type NMTOKEN "renderStyle"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
ElevationGrid |
[inherits X3DGeometryNode]
ElevationGrid is a geometry node defining a rectangular height field, with default values for a 1m by 1m square at height
0.
Vertices corresponding to ElevationGrid height values define quadrilaterals, which are placed above or below a flat surface.
Hint: the height array defines (xDimension-1)*(zDimension-1) quadrilaterals.
Warning: generated quadrilaterals can be nonplanar. Tessellation splits quadrilaterals into triangles along seam starting at initial
vertex of the quadrilateral and proceeding to opposite vertex.
Hint: positive direction for normal of each triangle is on same side of the quadrilateral. Triangles are defined either counterclockwise
or clockwise depending on value of ccw field.
Hint: ElevationGrid can contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance node (with correct containerField value)
for contained node content. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString
or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
|
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that specifies list of per-vertex attribute information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shaders.html#Pervertexattributes
|
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorPerVertex
field.
|
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry.
|
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that specifies perpendicular vectors for corresponding vertices to support rendering computations,
applied according to the normalPerVertex field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is quite fast so adding normals to a scene
is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions.
|
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that specifies coordinates
for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
|
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField,
which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining
a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
|
| xDimension |
[xDimension accessType initializeOnly, type SFInt32 CDATA "2"] (0,+∞)
Number of elements in the height array along X direction.
Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
Warning: xDimension < 2 means that ElevationGrid contains no quadrilaterals.
|
| zDimension |
[zDimension accessType initializeOnly, type SFInt32 CDATA "2"] (0,+∞)
Number of elements in the height array along Z direction.
Hint: total horizontal z-axis distance equals (zDimension-1) * zSpacing.
Warning: zDimension < 2 means that ElevationGrid contains no quadrilaterals.
|
| xSpacing |
[xSpacing accessType initializeOnly, type SFFloat CDATA "1.0"] (0,+∞)
Meters distance between grid-array vertices along X direction.
Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
|
| zSpacing |
[zSpacing accessType initializeOnly, type SFFloat CDATA "1.0"] (0,+∞)
Meters distance between grid-array vertices along Z direction.
Hint: total lateral z-axis distance equals (zDimension-1) * zSpacing.
|
| height |
[height accessType initializeOnly, type MFFloat CDATA "0 0 0 0"]
Grid array of height vertices with upward direction along +Y axis, with xDimension rows and zDimension columns.
Hint: height array values are given in row-major order from left to right along X axis, then back to front along Z axis.
Warning: height array values are not retained or available at run time since a browser is permitted to condense geometry.
|
| set_height |
[set_height accessType inputOnly, type MFFloat CDATA #FIXED ""]
Grid array of height vertices with upward direction along +Y axis, with xDimension rows and zDimension columns.
Hint: height array values are given in row-major order from left to right along X axis, then back to front along Z axis.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
|
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw = counterclockwise: ordering of vertex coordinates orientation, according to Right-Hand Rule (RHR).
Hint: ccw false can reverse solid (backface culling) and normal-vector orientation. Note that consistency of left-handed or right-handed
point sequences is important throughout.
|
| creaseAngle |
[creaseAngle accessType initializeOnly, type SFFloat CDATA "0"] [0,+∞)
creaseAngle defines angle (in radians) for determining whether adjacent polygons are drawn with sharp edges or smooth shading.
If angle between normals of two adjacent polygons is less than creaseAngle, smooth shading is rendered across the shared line
segment.
Hint: creaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all edges smoothly.
Hint: https://en.wikipedia.org/wiki/Radian
|
| solid |
[solid accessType initializeOnly, type SFBool (true|false) "true"]
Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides
of polygons (backface culling off).
Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
Warning: default value true can completely hide geometry if viewed from wrong side!
Hint: if in doubt, use solid='false' for maximum visibility.
|
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color node color values are applied to each point vertex (true) or per quadrilateral (false).
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
|
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or per quadrilateral (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate normals, using creaseAngle to determine
smoothed shading across shared vertices.
|
| containerField |
[containerField type NMTOKEN "geometry"]
containerField is a field-label prefix indicating this node's field relationship to its parent node, for example <Transform><Shape
containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need to override default containerField values
is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children' for Group node, containerField='proxy'
for hidden proxy shape within a Collision node, etc.
Hint: containerField attribute is part of XML encoding for X3D scenes, and corresponds to the always-declared field labels in
the ClassicVRML and VRML97 file encodings.
Hint: USE node instances are allowed to have a containerField value that is different than the corresponding DEF declaration of
that node.
Hint: X3D Scene Authoring Hints, containerField https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#containerField
|
| class |
[class type CDATA #IMPLIED]
The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
|
| |
accessType and type Credits and Translations X3D Resources |
EspduTransform |
[inherits X3DGroupingNode, implements X3DSensorNode]
EspduTransform is a netwo |
