| |
accessType and type Credits and Translations X3D Resources  |
AcousticProperties |
[inherits X3DAppearanceChildNode]
AcousticProperties specifies the interaction of sound waves with characteristics
of geometric objects in the scene. Acoustic coefficient values are expected to fully
account for physical and structural characteristics of associated geometry such as
width, height, thickness, shape, softness and/or hardness, and density variations.
Hint: AcousticProperties must have a parent Appearance node, and only affects geometry
within the same Shape.
Hint: proxy geometry for acoustic response can be far simpler than geometry needed for
visual rendering.
Hint: X3D Architecture Figure 16.2 Sound Propagation Phenomena https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/sound.html#f-SoundPropagationPhenomena |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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. |
| absorption |
[absorption accessType inputOutput, type SFFloat CDATA "0"] [0,1]
specifies the sound absorption coefficient of a surface, meaning the ratio of sound
intensity not reflected by a surface. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of the url asset.
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). |
| diffuse |
[diffuse accessType inputOutput, type SFFloat CDATA "0"] [0,1]
diffuse coefficient of sound reflection indicates how much of the incident sound
energy is reflected back in multiple directions. |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| refraction |
[refraction accessType inputOutput, type SFFloat CDATA "0"] [0,1]
sound refraction coefficient of a medium, which determines change in propagation
direction of sound wave when obliquely crossing boundary between two mediums where
its speed is different.
Hint: relationships described by Snell's Law https://en.wikipedia.org/wiki/Snell%27s_law |
| specular |
[specular accessType inputOutput, type SFFloat CDATA "0"] [0,1]
specular coefficient of sound reflection striking a plane surface, directly reflected
back into space, where angle of reflection equals angle of incidence. |
| containerField |
[containerField type NMTOKEN "acousticProperties"]
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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
|
Analyser |
[inherits X3DSoundProcessingNode]
Analyser provides real-time frequency and time-domain analysis information, without
any change to the input.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#analysernode |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DSoundChannelNode | X3DSoundProcessingNode | X3DSoundSourceNode]
The children field specifies audio-graph sound sources providing input signals for
this node. If multiple input signals are provided by the inputs children field, all
channels are mixed together and merged prior to presentation.
Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to
override otherwise-incorrect defaults.
Hint: can be original (DEF) or referenced (USE) nodes. |
| 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 prose that describes intended purpose of the url asset.
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. |
| fftSize |
[fftSize accessType inputOutput, type SFInt32 CDATA "2048"] (0,+∞)
fftSize represents size of Fast Fourier Transform (FFT) used to determine frequency
domain.
Hint: Fast Fourier Transform (FFT) https://en.wikipedia.org/wiki/Fast_Fourier_transform |
| frequencyBinCount |
[frequencyBinCount accessType inputOutput, type SFInt32 CDATA "2048"] (0,+∞)
frequencyBinCount is half of fftSize and generally equates to number of data values
available for the visualization. |
| gain |
[gain accessType inputOutput, type SFFloat CDATA "1"] (-∞,+∞)
The gain field is a factor that represents the amount of linear amplification to
apply to the output of the node.
Warning: Decibel values shall not be used.
Hint: Negative gain factors negate the input signal. |
| minDecibels |
[minDecibels accessType inputOutput, type SFFloat CDATA "-100"] (-∞,+∞)
minDecibels represents minimum power value in scaling range for FFT analysis data.
|
| maxDecibels |
[maxDecibels accessType inputOutput, type SFFloat CDATA "-30"] (-∞,+∞)
maxDecibels represents maximum power value in scaling range for FFT analysis data.
|
| smoothingTimeConstant |
[smoothingTimeConstant accessType inputOutput, type SFFloat CDATA "0.8"] (0,+∞)
smoothingTimeConstant represents averaging constant during last analysis frame.
|
| tailTime |
[tailTime accessType inputOutput, type SFTime CDATA "0"] [0,+∞)
tailTime is duration of time that a node continues to provide output signal after
the input signal becomes silent.
Hint: tailTime always has a value of zero for Analyser. |
| channelCount |
[channelCount accessType outputOnly, type SFInt32 CDATA] [0,+∞)
channelCount reports number of channels provided by input nodes.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcount |
| channelCountMode |
[channelCountMode accessType inputOutput, type SFString CDATA ( MAX|CLAMPED_MAX|EXPLICIT ) MAX]
channelCountMode determines how individual channels are counted when up-mixing and
down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode |
| channelInterpretation |
[channelInterpretation accessType inputOutput, type SFString CDATA ( SPEAKERS|DISCRETE ) SPEAKERS]
channelInterpretation determines how individual channels are treated when up-mixing
and down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation |
| 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. |
| 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.
|
| 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. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
Anchor |
[inherits X3DGroupingNode, implements X3DUrlObject, X3DVisibleObject]
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: when parent node is LoadSensor, apply containerField='children' (X3Dv4) or containerField='watchList'
(X3Dv3). https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.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. |
| autoRefresh |
[autoRefresh accessType inputOutput, type SFTime CDATA "0.0"]
The [autoRefresh field has no effect, Anchor operation is only triggered by user
selection. |
| autoRefreshTimeLimit |
[autoRefreshTimeLimit accessType inputOutput, type SFTime CDATA "3600.0"]
The [autoRefreshTimeLimit field has no effect, Anchor operation is only triggered
by user selection. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of the url asset.
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). |
| load |
[load accessType inputOutput, type SFBool (true|false) "true"]
The load field has no effect, Anchor operation is only triggered by user selection.
|
| 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 (for example, #ViewpointName,
someOtherCoolWorld.x3d#GrandTour).
Hint: jump to a local viewpoint by only using viewpoint name (for example, #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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"] or [0,+∞)
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxDisplay |
[bboxDisplay accessType inputOutput, type SFBool (true|false) "false"]
Whether to display bounding box for associated geometry, aligned with world coordinates.
Hint: the bounding box is displayed regardless of whether contained content is visible.
|
| visible |
[visible accessType inputOutput, type SFBool (true|false) "true"]
Whether or not renderable content within this node is visually displayed.
Hint: the visible field has no effect on animation behaviors, event passing or other non-visual
characteristics.
Hint: content must be visible to be collidable and to be pickable. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shape.html#Appearancenode
Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| backMaterial |
[backMaterial accessType inputOutput, type SFNode singleton, NULL node] [X3DMaterialNode]
Single contained Material, PhysicalMaterial or UnlitMaterial node that can specify
visual attributes for lighting response (color types, transparency, etc.) applied
to back faces of corresponding geometry.
Warning: it is only allowed to define a backMaterial field if the material field is also
defined (not NULL).
Warning: the node type for backMaterial field (if any) must match node type for material
field.
Warning: if material is NULL or unspecified, lighting is off (all lights ignored) for this
Shape and unlit object color is (1, 1, 1). |
| material |
[material accessType inputOutput, type SFNode singleton, NULL node] [X3DMaterialNode]
Single contained Material, PhysicalMaterial, TwoSidedMaterial (deprecated), or UnlitMaterial
node that can specify 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). |
| acousticProperties |
[acousticProperties accessType inputOutput, type SFNode singleton, NULL node] [AcousticProperties]
Single contained acousticProperties node that can specify additional acoustic attributes
applied to associated surface geometry. |
| alphaCutoff |
[alphaCutoff accessType inputOutput, type SFFloat CDATA "0.5"] [0,1]
Threshold value used for pixel rendering either transparent or opaque, used when
alphaMode="MASK".
Hint: glTF version 2 Alpha Coverage, https://www.khronos.org/registry/glTF/specs/2.0/glTF-2.0.html#alpha-coverage |
| alphaMode |
[alphaMode accessType inputOutput, type SFString CDATA (AUTO|OPAQUE|MASK|BLEND) "AUTO"]
Provides options for control of alpha transparency handling for textures. AUTO means
Material transparency is applied to texture transparency for full backwards compatility
with X3D3, OPAQUE means ignore alpha transparency to render texture as opaque, MASK
means alpha-testing of pixels as fully transparent when alpha value is less than alphaCutoff
and fully opaque when alpha value is greater than or equal to alphaCutoff, BLEND combines
partial transparency of textures and materials.
Hint: glTF version 2 Alpha Coverage, https://www.khronos.org/registry/glTF/specs/2.0/glTF-2.0.html#alpha-coverage |
| fillProperties |
[fillProperties accessType inputOutput, type SFNode singleton, NULL node] [FillProperties]
Single contained FillProperties node that can specify 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 can specify additional visual attributes
applied to corresponding line geometry. |
| pointProperties |
[pointProperties accessType inputOutput, type SFNode singleton, NULL node] [LineProperties]
Single contained PointProperties node that can specify additional visual attributes
applied to corresponding point 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html
Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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: Texture coordinates are reapplied (or else recomputed if textureTransform field
initially NULL) whenever the corresponding vertex-based geometry changes.
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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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://www.web3d.org/x3d/content/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node 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, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
Hint: radian units for angular measure 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, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
Hint: radian units for angular measure 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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://www.web3d.org/x3d/content/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node 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, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
Hint: radian units for angular measure 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, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
Hint: radian units for angular measure 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 inputOutput, 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.
Hint: accessType relaxed to inputOutput in order to support animation and visualization.
|
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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: when parent node is LoadSensor, apply containerField='children' (X3Dv4) or containerField='watchList'
(X3Dv3). https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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. |
| autoRefresh |
[autoRefresh accessType inputOutput, type SFTime CDATA "0.0"]
autoRefresh defines interval in seconds before automatic reload of current url asset
is performed.
Hint: if preceding file loading fails or load field is false, no refresh is performed.
Hint: repeated refresh attempts to reload currently loaded entry of url list. If that
fails, the browser retries other entries in the url list.
Warning: automatically reloading content has security considerations and needs to be considered
carefully. |
| autoRefreshTimeLimit |
[autoRefreshTimeLimit accessType inputOutput, type SFTime CDATA "3600.0"]
autoRefreshTimeLimit defines maximum duration that automatic refresh activity can
occur.
Hint: Automatic refresh is different than query and response timeouts performed by a networking
library while sequentially attempting to retrieve addressed content from a url list.
Warning: automatically reloading content has security considerations and needs to be considered
carefully. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of the url asset.
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. |
| gain |
[gain accessType inputOutput, type SFFloat CDATA "1"] (-∞,+∞)
The gain field is a factor that represents the amount of linear amplification to
apply to the output of the node.
Warning: Decibel values shall not be used.
Hint: Negative gain factors negate the input signal. |
| load |
[load accessType inputOutput, type SFBool (true|false) "true"]
load=true means load immediately, load=false means defer loading or else unload
a previously loaded scene.
Hint: allows author to design when Inline loading occurs via user interaction, event chains
or scripting.
Hint: use a separate LoadSensor node to detect when loading is complete. |
| loop |
[loop accessType inputOutput, type SFBool (true|false) "false"]
Repeat indefinitely when loop=true, repeat only once when loop=false. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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 |
| 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. |
| 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.
|
| 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. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
|
AudioDestination |
[inherits X3DSoundDestinationNode]
AudioDestination node represents the final audio destination and is what user ultimately
hears, typically from the speakers of user device. An AudioDestinationNode representing
the audio hardware end-point (the normal case) can potentially output more than 2
channels of audio if the audio hardware is multi-channel.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#AudioDestinationNode |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DSoundChannelNode | X3DSoundProcessingNode | X3DSoundSourceNode]
The children field specifies audio-graph sound sources providing input signals for
this node. If multiple input signals are provided by the inputs children field, all
channels are mixed together and merged prior to presentation.
Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to
override otherwise-incorrect defaults.
Hint: can be original (DEF) or referenced (USE) nodes. |
| 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 prose that describes intended purpose of the url asset.
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. |
| gain |
[gain accessType inputOutput, type SFFloat CDATA "1"] (-∞,+∞)
The gain field is a factor that represents the amount of linear amplification to
apply to the output of the node.
Warning: Decibel values shall not be used.
Hint: Negative gain factors negate the input signal. |
| maxChannelCount |
[maxChannelCount accessType outputOnly, type SFInt32 CDATA] [0,+∞)
[maxChannelCount.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcount |
| channelCount |
[channelCount accessType outputOnly, type SFInt32 CDATA] [0,+∞)
channelCount reports number of channels provided by input nodes.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcount |
| channelCountMode |
[channelCountMode accessType inputOutput, type SFString CDATA ( MAX|CLAMPED_MAX|EXPLICIT ) MAX]
channelCountMode determines how individual channels are counted when up-mixing and
down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode |
| channelInterpretation |
[channelInterpretation accessType inputOutput, type SFString CDATA ( SPEAKERS|DISCRETE ) SPEAKERS]
channelInterpretation determines how individual channels are treated when up-mixing
and down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation |
| mediaDeviceID |
[mediaDeviceID accessType outputOnly, type SFString CDATA #FIXED ""]
mediaDeviceID field provides ID parameter functionality. (TODO experimental) |
| 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. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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.
Avoid this authoring pattern.
Hint: Background node is not sensed by LoadSensor due to node typing and multiple-image
ambiguity, alternatively utilize TextureBackground node with multiple ImageTexture
nodes each referenced inside LoadSensor.
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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: radian units for angular measure 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: radian units for angular measure 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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 |
| body1 |
[body1 accessType inputOutput, type SFNode singleton, NULL node] [RigidBody]
The body1 and body2 fields indicate the two RigidBody nodes connected by this joint.
|
| body2 |
[body2 accessType inputOutput, type SFNode singleton, NULL node] [RigidBody]
The body1 and body2 fields indicate the two RigidBody nodes connected by this joint.
|
| 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
Billboard |
[inherits X3DGroupingNode, implements X3DVisibleObject]
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"] or [0,+∞)
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxDisplay |
[bboxDisplay accessType inputOutput, type SFBool (true|false) "false"]
Whether to display bounding box for associated geometry, aligned with world coordinates.
Hint: the bounding box is displayed regardless of whether contained content is visible.
|
| visible |
[visible accessType inputOutput, type SFBool (true|false) "true"]
Whether or not renderable content within this node is visually displayed.
Hint: the visible field has no effect on animation behaviors, event passing or other non-visual
characteristics.
Hint: content must be visible to be collidable and to be pickable. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
|
BiquadFilter |
[inherits X3DSoundProcessingNode]
BiquadFilter node is an AudioNode processor implementing common low-order filters.
Low-order filters are the building blocks of basic tone controls (bass, mid, treble),
graphic equalizers, and more advanced filters. Multiple BiquadFilter node filters
can be combined to form more complex filters. The filter parameters such as frequency
can be changed over time for filter sweeps, etc.
Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to
override otherwise-incorrect defaults.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#biquadfilternode |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DSoundChannelNode | X3DSoundProcessingNode | X3DSoundSourceNode]
The children field specifies audio-graph sound sources providing input signals for
this node. If multiple input signals are provided by the inputs children field, all
channels are mixed together and merged prior to presentation.
Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to
override otherwise-incorrect defaults.
Hint: can be original (DEF) or referenced (USE) nodes. |
| 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 prose that describes intended purpose of the url asset.
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). |
| detune |
[detune accessType inputOutput, type SFFloat CDATA "0"] (0,+∞)
The detune field forms a compound field together with playbackRate that together
determine a computedPlaybackRate value.
Hint: computedPlaybackRate(t) = playbackRate(t) * pow(2, detune(t) / 1200) |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| frequency |
[frequency accessType inputOutput, type SFFloat CDATA "350"] [0,+∞)
frequency at which the BiquadFilterNode operates, in Hz.
Hint: Wikipedia Hertz https://en.wikipedia.org/wiki/Hertz |
| gain |
[gain accessType inputOutput, type SFFloat CDATA "1"] (-∞,+∞)
The gain field is a factor that represents the amount of linear amplification to
apply to the output of the node.
Warning: Decibel values shall not be used.
Hint: Negative gain factors negate the input signal. |
| qualityFactor |
[qualityFactor accessType inputOutput, type SFFloat CDATA "1"] [0,+∞)
qualityFactor is Quality Factor (Q) of the respective filter algorithm.
Hint: Wikipedia Q factor https://en.wikipedia.org/wiki/Q_factor |
| tailTime |
[tailTime accessType inputOutput, type SFTime CDATA "0"] [0,+∞)
tailTime is duration of time that a node continues to provide output signal after
the input signal becomes silent. |
| type |
[type accessType inputOutput, type SFString CDATA ( LOWPASS|HIGHPASS|BANDPASS|LOWSHELF|HIGHSHELF|PEAKING|NOTCH|ALLPASS ) LOWPASS]
type selects which BiquadFilter algorithm is used.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#enumdef-biquadfiltertype |
| channelCount |
[channelCount accessType outputOnly, type SFInt32 CDATA] [0,+∞)
channelCount reports number of channels provided by input nodes.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcount |
| channelCountMode |
[channelCountMode accessType inputOutput, type SFString CDATA ( MAX|CLAMPED_MAX|EXPLICIT ) MAX]
channelCountMode determines how individual channels are counted when up-mixing and
down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode |
| channelInterpretation |
[channelInterpretation accessType inputOutput, type SFString CDATA ( SPEAKERS|DISCRETE ) SPEAKERS]
channelInterpretation determines how individual channels are treated when up-mixing
and down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation |
| 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. |
| 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.
|
| 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. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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'.
Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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. |
| weightTransferFunction1 |
[weightTransferFunction1 accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode]
The weightTransferFunction1 and weightTransferFunction2 fields specify two-dimensional
textures that are used to determine the weight values when the weight function is
set to "TABLE". The output weight value depends on the number of components in the
textures as specified in Table 41.4.
Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/volume.html#t-transferFunctionToWeightMapping |
| weightTransferFunction2 |
[weightTransferFunction2 accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode]
The weightTransferFunction1 and weightTransferFunction2 fields specify two-dimensional
textures that are used to determine the weight values when the weight function is
set to "TABLE". The output weight value depends on the number of components in the
textures as specified in Table 41.4.
Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/volume.html#t-transferFunctionToWeightMapping |
| 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/volume.html#t-WeightFunctionTypes
Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/volume.html#t-WeightFunctionTypes
Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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 https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
Hint: X3D Event-Utility Node Diagrams https://www.web3d.org/x3d/content/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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 https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
Hint: X3D Event-Utility Node Diagrams https://www.web3d.org/x3d/content/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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 https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
Hint: X3D Event-Utility Node Diagrams https://www.web3d.org/x3d/content/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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 https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
Hint: X3D Event-Utility Node Diagrams https://www.web3d.org/x3d/content/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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.
Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| surfaceNormals |
[surfaceNormals accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture3DNode]
The surfaceNormals field contains a 3D texture with at least three component values.
Each voxel in the texture represents the surface normal direction for the corresponding
voxel in the base data source. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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 https://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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node 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.
Hint: accessType relaxed to inputOutput in order to support animation and visualization.
|
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
|
BufferAudioSource |
[inherits X3DSoundSourceNode]
BufferAudioSource node represents a memory-resident audio asset that can contain
one or more channels. Typically the length of the Pulse Coded Modulation (PCM) data
is expected to be fairly short (usually somewhat less than a minute).
Warning: for longer sounds, such as music soundtracks, streaming such as StreamAudioSource
should be used.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#AudioBufferSourceNode |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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. |
| autoRefresh |
[autoRefresh accessType inputOutput, type SFTime CDATA "0.0"]
autoRefresh defines interval in seconds before automatic reload of current url asset
is performed.
Hint: if preceding file loading fails or load field is false, no refresh is performed.
Hint: repeated refresh attempts to reload currently loaded entry of url list. If that
fails, the browser retries other entries in the url list.
Warning: automatically reloading content has security considerations and needs to be considered
carefully. |
| autoRefreshTimeLimit |
[autoRefreshTimeLimit accessType inputOutput, type SFTime CDATA "3600.0"]
autoRefreshTimeLimit defines maximum duration that automatic refresh activity can
occur.
Hint: Automatic refresh is different than query and response timeouts performed by a networking
library while sequentially attempting to retrieve addressed content from a url list.
Warning: automatically reloading content has security considerations and needs to be considered
carefully. |
| buffer |
[buffer accessType inputOutput, type MFFloat CDATA ""]
buffer is a memory-resident audio asset that can contain one or more channels. buffer
data format is non-interleaved 32-bit floating-point linear PCM values with a normal
range of [−1,1], but values are not limited to this range.
Hint: Wikipedia Pulse-Code Modulation (PCM) https://en.wikipedia.org/wiki/Pulse-code_modulation |
| bufferDuration |
[bufferDuration accessType inputOutput, type SFTime CDATA "1"] [0,+∞)
bufferDuration is duration in seconds to use from buffer field.
Hint: duration is a nonnegative SFTime duration interval, not an absolute clock time.
|
| bufferLength |
[bufferLength accessType inputOutput, type SFTime CDATA "1"] [0,+∞)
bufferLength is length of buffer field in sample-frames. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of the url asset.
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). |
| detune |
[detune accessType inputOutput, type SFFloat CDATA "0"] (0,+∞)
The detune field forms a compound field together with playbackRate that together
determine a computedPlaybackRate value.
Hint: computedPlaybackRate(t) = playbackRate(t) * pow(2, detune(t) / 1200) |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| gain |
[gain accessType inputOutput, type SFFloat CDATA "1"] (-∞,+∞)
The gain field is a factor that represents the amount of linear amplification to
apply to the output of the node.
Warning: Decibel values shall not be used.
Hint: Negative gain factors negate the input signal. |
| load |
[load accessType inputOutput, type SFBool (true|false) "true"]
load=true means load immediately, load=false means defer loading or else unload
a previously loaded scene.
Hint: allows author to design when Inline loading occurs via user interaction, event chains
or scripting.
Hint: use a separate LoadSensor node to detect when loading is complete. |
| loop |
[loop accessType inputOutput, type SFBool (true|false) "false"]
Repeat indefinitely when loop=true, repeat only once when loop=false. |
| loopStart |
[loopStart accessType inputOutput, type SFTime CDATA "0"] [0,+∞)
loopStart field is optional playhead position where looping begins if loop=true.
If loopStart is greater than duration of buffer, looping starts at buffer end.
Hint: loopStart represents a nonnegative SFTime duration interval, not an absolute clock
time. |
| loopEnd |
[loopEnd accessType inputOutput, type SFTime CDATA "0"] [0,+∞)
loopEnd field is optional playhead position where looping ends if loop=true. If
loopEnd value is zero, or if loopEnd is greater than duration of buffer, looping ends
at buffer end.
Hint: loopEnd represents a nonnegative SFTime duration interval, not an absolute clock
time. |
| numberOfChannels |
[numberOfChannels accessType outputOnly, type SFInt32 CDATA] [0,+∞)
numberOfChannels is number of audio channels found in this buffer source. |
| playbackRate |
[playbackRate accessType inputOutput, type SFFloat CDATA "1"] (-∞,+∞)
playbackRate field is speed at which to render the audio stream, and forms a compound
field together with detune field
Hint: negative values play in reverse. |
| sampleRate |
[sampleRate accessType inputOutput, type SFFloat CDATA "0"] (-∞,+∞)
sampleRate field is sample-frames per second.
Hint: sample-rate converters (variable speed processors) are not supported in real-time
processing.
Hint: Nyquist frequency is half this sampleRate value.
Hint: Wikipedia Nyquist frequency https://en.wikipedia.org/wiki/Nyquist_frequency |
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Location and filename of sound file. 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 |
| channelCount |
[channelCount accessType outputOnly, type SFInt32 CDATA] [0,+∞)
channelCount reports number of channels provided by input nodes.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcount |
| channelCountMode |
[channelCountMode accessType inputOutput, type SFString CDATA ( MAX|CLAMPED_MAX|EXPLICIT ) MAX]
channelCountMode determines how individual channels are counted when up-mixing and
down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode |
| channelInterpretation |
[channelInterpretation accessType inputOutput, type SFString CDATA ( SPEAKERS|DISCRETE ) SPEAKERS]
channelInterpretation determines how individual channels are treated when up-mixing
and down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation |
| 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. |
| 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.
|
| 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. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
CADAssembly |
(X3D version 3.1 or later) [inherits X3DGroupingNode, implements X3DProductStructureChildNode, X3DVisibleObject]
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: Datum reference https://en.wikipedia.org/wiki/Datum_reference
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.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 SFString #IMPLIED]
Optional name for this particular CAD node.
Warning: name field is not included if this instance is a USE node, in order to avoid potential
mismatches.
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"] or [0,+∞)
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxDisplay |
[bboxDisplay accessType inputOutput, type SFBool (true|false) "false"]
Whether to display bounding box for associated geometry, aligned with world coordinates.
Hint: the bounding box is displayed regardless of whether contained content is visible.
|
| visible |
[visible accessType inputOutput, type SFBool (true|false) "true"]
Whether or not renderable content within this node is visually displayed.
Hint: the visible field has no effect on animation behaviors, event passing or other non-visual
characteristics.
Hint: content must be visible to be collidable and to be pickable. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
|
CADFace |
(X3D version 3.1 or later) [inherits X3DProductStructureChildNode, implements X3DBoundedObject, X3DVisibleObject]
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 https://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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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 SFString #IMPLIED]
Optional name for this particular CAD node.
Warning: name field is not included if this instance is a USE node, in order to avoid potential
mismatches.
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"] or [0,+∞)
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxDisplay |
[bboxDisplay accessType inputOutput, type SFBool (true|false) "false"]
Whether to display bounding box for associated geometry, aligned with world coordinates.
Hint: the bounding box is displayed regardless of whether contained content is visible.
|
| visible |
[visible accessType inputOutput, type SFBool (true|false) "true"]
Whether or not renderable content within this node is visually displayed.
Hint: the visible field has no effect on animation behaviors, event passing or other non-visual
characteristics.
Hint: content must be visible to be collidable and to be pickable. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
|
CADLayer |
(X3D version 3.1 or later) [inherits X3DGroupingNode, implements X3DVisibleObject]
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 https://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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.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 SFString #IMPLIED]
Optional name for this particular CAD node.
Warning: name field is not included if this instance is a USE node, in order to avoid potential
mismatches.
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"] or [0,+∞)
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxDisplay |
[bboxDisplay accessType inputOutput, type SFBool (true|false) "false"]
Whether to display bounding box for associated geometry, aligned with world coordinates.
Hint: the bounding box is displayed regardless of whether contained content is visible.
|
| visible |
[visible accessType inputOutput, type SFBool (true|false) "true"]
Whether or not renderable content within this node is visually displayed.
Hint: the visible field has no effect on animation behaviors, event passing or other non-visual
characteristics.
Hint: content must be visible to be collidable and to be pickable.
Warning: CADLayer visible field had type MFBool in X3Dv3, thus is not backwards compatible.
|
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
|
CADPart |
(X3D version 3.1 or later) [inherits X3DGroupingNode, implements X3DProductStructureChildNode, X3DVisibleObject]
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 https://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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.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 SFString #IMPLIED]
Optional name for this particular CAD node.
Warning: name field is not included if this instance is a USE node, in order to avoid potential
mismatches.
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"] or [0,+∞)
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxDisplay |
[bboxDisplay accessType inputOutput, type SFBool (true|false) "false"]
Whether to display bounding box for associated geometry, aligned with world coordinates.
Hint: the bounding box is displayed regardless of whether contained content is visible.
|
| visible |
[visible accessType inputOutput, type SFBool (true|false) "true"]
Whether or not renderable content within this node is visually displayed.
Hint: the visible field has no effect on animation behaviors, event passing or other non-visual
characteristics.
Hint: content must be visible to be collidable and to be pickable. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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'
Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| surfaceNormals |
[surfaceNormals accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture3DNode]
The surfaceNormals field contains a 3D texture with at least three component values.
Each voxel in the texture represents the surface normal direction for the corresponding
voxel in the base data source. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
|
ChannelMerger |
[inherits X3DSoundChannelNode]
ChannelMerger unites different input channels into a single output channel.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#channelmergernode |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DSoundChannelNode | X3DSoundProcessingNode | X3DSoundSourceNode]
The children field specifies audio-graph sound sources providing input signals for
this node. If multiple input signals are provided by the inputs children field, all
channels are mixed together and merged prior to presentation.
Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to
override otherwise-incorrect defaults.
Hint: can be original (DEF) or referenced (USE) nodes. |
| 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 prose that describes intended purpose of the url asset.
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. |
| gain |
[gain accessType inputOutput, type SFFloat CDATA "1"] (-∞,+∞)
The gain field is a factor that represents the amount of linear amplification to
apply to the output of the node.
Warning: Decibel values shall not be used.
Hint: Negative gain factors negate the input signal. |
| channelCount |
[channelCount accessType outputOnly, type SFInt32 CDATA] [0,+∞)
channelCount reports number of channels provided by input nodes.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcount |
| channelCountMode |
[channelCountMode accessType inputOutput, type SFString CDATA ( MAX|CLAMPED_MAX|EXPLICIT ) MAX]
channelCountMode determines how individual channels are counted when up-mixing and
down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode |
| channelInterpretation |
[channelInterpretation accessType inputOutput, type SFString CDATA ( SPEAKERS|DISCRETE ) SPEAKERS]
channelInterpretation determines how individual channels are treated when up-mixing
and down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
|
ChannelSelector |
[inherits X3DSoundChannelNode]
ChannelSelector selects a single channel output from all input channels.
Hint: ChannelSelector is a utility node to complement ChannelSplitter. |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DSoundChannelNode | X3DSoundProcessingNode | X3DSoundSourceNode]
The children field specifies audio-graph sound sources providing input signals for
this node. If multiple input signals are provided by the inputs children field, all
channels are mixed together and merged prior to presentation.
Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to
override otherwise-incorrect defaults.
Hint: can be original (DEF) or referenced (USE) nodes. |
| 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 prose that describes intended purpose of the url asset.
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. |
| gain |
[gain accessType inputOutput, type SFFloat CDATA "1"] (-∞,+∞)
The gain field is a factor that represents the amount of linear amplification to
apply to the output of the node.
Warning: Decibel values shall not be used.
Hint: Negative gain factors negate the input signal. |
| channelSelection |
[channelSelection accessType outputOnly, type SFInt32 CDATA] [0,+∞)
channelSelection is single channel of interest from those provided by input nodes.
|
| channelCount |
[channelCount accessType outputOnly, type SFInt32 CDATA] [0,+∞)
channelCount reports number of channels provided by input nodes.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcount |
| channelCountMode |
[channelCountMode accessType inputOutput, type SFString CDATA ( MAX|CLAMPED_MAX|EXPLICIT ) MAX]
channelCountMode determines how individual channels are counted when up-mixing and
down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode |
| channelInterpretation |
[channelInterpretation accessType inputOutput, type SFString CDATA ( SPEAKERS|DISCRETE ) SPEAKERS]
channelInterpretation determines how individual channels are treated when up-mixing
and down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
|
ChannelSplitter |
[inherits X3DSoundChannelNode]
ChannelSplitter separates the different channels of a single audio source into a
set of monophonic output channels.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#channelsplitternode |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DSoundChannelNode | X3DSoundProcessingNode | X3DSoundSourceNode]
The children field specifies audio-graph sound sources providing input signals for
this node, making up a section of the audio graph. If multiple input signals are provided
by the inputs children field, all channels are mixed together and merged prior to
presentation.
Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to
override otherwise-incorrect defaults.
Hint: can be original (DEF) or referenced (USE) nodes. |
| outputs |
[outputs accessType inputOutput, type MFNode array, empty list] [X3DSoundChannelNode | X3DSoundProcessingNode | X3DSoundSourceNode]
The outputs field is a set of output nodes receiving the split channels, and making
up a section of the audio graph.
Hint: can be original (DEF) or referenced (USE) nodes. |
| 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 prose that describes intended purpose of the url asset.
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. |
| gain |
[gain accessType inputOutput, type SFFloat CDATA "1"] (-∞,+∞)
The gain field is a factor that represents the amount of linear amplification to
apply to the output of the node.
Warning: Decibel values shall not be used.
Hint: Negative gain factors negate the input signal. |
| channelCount |
[channelCount accessType outputOnly, type SFInt32 CDATA] [0,+∞)
channelCount reports number of channels provided by input nodes.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcount |
| channelCountMode |
[channelCountMode accessType inputOutput, type SFString CDATA ( MAX|CLAMPED_MAX|EXPLICIT ) MAX]
channelCountMode determines how individual channels are counted when up-mixing and
down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode |
| channelInterpretation |
[channelInterpretation accessType inputOutput, type SFString CDATA ( SPEAKERS|DISCRETE ) SPEAKERS]
channelInterpretation determines how individual channels are treated when up-mixing
and down-mixing connections to any inputs.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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://www.web3d.org/x3d/content/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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 https://en.wikipedia.org/wiki/Plane_(geometry)#Point-normal_form_and_general_form_of_the_equation_of_a_plane
Hint: plane-geometry distance to point https://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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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').
Hint: content must be visible to be collidable and to be pickable. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| collidable |
[collidable accessType inputOutput, type SFNode singleton, NULL node] [X3DNBodyCollidableNode]
The collidable field holds a reference to a single nested item of a collidable scene
graph.
Warning: if there are multiple transformation paths to this reference, the results are undefined.
|
| 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"] or [0,+∞)
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxDisplay |
[bboxDisplay accessType inputOutput, type SFBool (true|false) "false"]
Whether to display bounding box for associated geometry, aligned with world coordinates.
Hint: the bounding box is displayed regardless of whether contained content is visible.
|
| visible |
[visible accessType inputOutput, type SFBool (true|false) "true"]
Whether or not renderable content within this node is visually displayed.
Hint: the visible field has no effect on animation behaviors, event passing or other non-visual
characteristics.
Hint: content must be visible to be collidable and to be pickable. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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.
Hint: content must be visible to be collidable and to be pickable. |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| shape |
[shape accessType initializeOnly, type SFNode singleton, NULL node] [Shape]
The shape field provides a geometry proxy for specifying which geometry best represents
the collidable object. |
| 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"] or [0,+∞)
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxDisplay |
[bboxDisplay accessType inputOutput, type SFBool (true|false) "false"]
Whether to display bounding box for associated geometry, aligned with world coordinates.
Hint: the bounding box is displayed regardless of whether contained content is visible.
|
| visible |
[visible accessType inputOutput, type SFBool (true|false) "true"]
Whether or not renderable content within this node is visually displayed.
Hint: the visible field has no effect on animation behaviors, event passing or other non-visual
characteristics.
Hint: content must be visible to be collidable and to be pickable. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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: content must be visible to be collidable and to be pickable.
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.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. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of the 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). |
| 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. |
| 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"] or [0,+∞)
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxDisplay |
[bboxDisplay accessType inputOutput, type SFBool (true|false) "false"]
Whether to display bounding box for associated geometry, aligned with world coordinates.
Hint: the bounding box is displayed regardless of whether contained content is visible.
|
| visible |
[visible accessType inputOutput, type SFBool (true|false) "true"]
Whether or not renderable content within this node is visually displayed.
Hint: the visible field has no effect on animation behaviors, event passing or other non-visual
characteristics.
Hint: content must be visible to be collidable and to be pickable. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
accessType and type Credits and Translations X3D Resources |
CollisionCollection |
(X3D version 3.2 or later) [inherits X3DChildNode, implements X3DBoundedObject]
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').
Hint: content must be visible to be collidable and to be pickable. |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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). |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of the 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). |
| 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. |
| 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"] or [0,+∞)
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxDisplay |
[bboxDisplay accessType inputOutput, type SFBool (true|false) "false"]
Whether to display bounding box for associated geometry, aligned with world coordinates.
Hint: the bounding box is displayed regardless of whether contained content is visible.
|
| visible |
[visible accessType inputOutput, type SFBool (true|false) "true"]
Whether or not renderable content within this node is visually displayed.
Hint: the visible field has no effect on animation behaviors, event passing or other non-visual
characteristics.
Hint: content must be visible to be collidable and to be pickable. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#ExecutionModel
Hint: content must be visible to be collidable and to be pickable. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| collider |
[collider accessType inputOutput, type SFNode singleton, NULL node] [CollisionCollection]
The collider field specifies a CollisionCollection node that holds a collidables
field of nodes and spaces that are to be included in collision-detection computations.
|
| 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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 prose that describes intended purpose of the 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). |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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').
Hint: content must be visible to be collidable and to be pickable. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| collidables |
[collidables accessType inputOutput, type MFNode array, empty list] [X3DNBodyCollisionSpaceNode,X3DNBodyCollidableNode]
Collection of collidable objects as well as nested CollisionSpace collections |
| 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxSize |
[bboxSize accessType initializeOnly, type SFVec3f CDATA "-1 -1 -1"] or [0,+∞)
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject |
| bboxDisplay |
[bboxDisplay accessType inputOutput, type SFBool (true|false) "false"]
Whether to display bounding box for associated geometry, aligned with world coordinates.
Hint: the bounding box is displayed regardless of whether contained content is visible.
|
| visible |
[visible accessType inputOutput, type SFBool (true|false) "true"]
Whether or not renderable content within this node is visually displayed.
Hint: the visible field has no effect on animation behaviors, event passing or other non-visual
characteristics.
Hint: content must be visible to be collidable and to be pickable. |
| 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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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
Hint: example scenes and authoring assets at https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation |
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/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.
Warning: containerField attribute is only part of XML encoding for X3D scenes, and corresponds
to the always-declared field names 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 NMTOKENS #IMPLIED]
The class attribute on each X3D node and statement is a space-separated list of
classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| id |
[id type NMTOKEN #IMPLIED]
The id attribute on each X3D node and statement is considered a unique identifier
when used as part of an encompassing HTML/DOM context.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus
not applicable for USE nodes, ROUTE statements, or Script references.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id |
| style |
[style type CDATA #IMPLIED]
The style attribute on each X3D node and statement provides an inline block of CSS
source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML
stylesheets.
Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/htmlGuidelines.html#CSS
Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
Hint: CSS Snapshot https://www.w3.org/TR/css-2018
Hint: https://www.w3.org/TR/css-style-attr
Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets |
| |
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, |
