| |
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, 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 MFColorRGBA CDATA #IMPLIED] [0,1]
The color field defines an array of 4-tuple RGBA colors.
Warning: ColorRGBA requires Rendering component level 3 (alpha fully supported), Rendering
component level 1 (alpha optional), otherwise Full profile. |
| containerField |
[containerField type (color|colorRamp) "color"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
component |
[X3D statement]
Each added component statement indicates needed scene functionality above the given
X3D profile.
Hint: component statements are optional secondary children of head statement (add a head
statement first).
Hint: X3D XML Encoding https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#Header
Warning: the COMPONENT statement is capitalized in the X3D Architecture specification and
in the X3D ClassicVRML Encoding.
Hint: X3D Architecture 7.2.5.4 COMPONENT statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#COMPONENTStatement |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| name |
[name type ENUMERATION #REQUIRED (Core|CADGeometry|CubeMapTexturing|DIS|EnvironmentalEffects|EnvironmentalSensor|EventUtilities|Followers|Geometry2D|Geometry3D|Geospatial|Grouping|HAnim|Interpolation|KeyDeviceSensor|Layering|Layout|Lighting|Navigation|Networking|NURBS|ParticleSystems|Picking|PointingDeviceSensor|Rendering|RigidBodyPhysics|Scripting|Shaders|Shape|Sound|Text|TextureProjection|Texturing|Texturing3D|Time)]
Provides name of this component, as defined in corresponding X3D Specification component
Introduction.
Example: X3D Architecture 10.1.1 Name for Grouping component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#Name
Hint: all nodes, components and levels are already supported in Full profile.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| level |
[level type SFInt32 #REQUIRED (1|2|3|4|5)]
Necessary level of support for this scene, as defined in corresponding Support table
for a given node's component.
Hint: for example specification definitions, X3D Architecture Grouping component, 10.5
Support levels https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#SupportLevels |
| 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 |
ComposedCubeMapTexture |
(X3D version 3.1 or later) [inherits X3DEnvironmentTextureNode]
ComposedCubeMapTexture is a texture node that defines a cubic environment map source
as an explicit set of images drawn from individual 2D texture nodes.
Hint: 0..6 child image nodes are allowed (ImageTexture MovieTexture PixelTexture) with
corresponding containerField values: front back left right top bottom.
Warning: each of the child ImageTexture or PixelTexture nodes must have unique containerField
values for backTexture, bottomTexture, frontTexture, leftTexture, rightTexture, or
topTexture.
Warning: fields originally named back, bottom, front, left, right, or top in X3Dv3. |
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 |
| backTexture |
[backTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode]
Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture
PixelTexture MovieTexture, other texture nodes).
Warning: each child image node must have a different containerField value.
Warning: field originally named 'back' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges |
| bottomTexture |
[bottomTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode]
Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture
PixelTexture, other texture nodes).
Warning: each child image node must have a different containerField value.
Warning: field originally named 'bottom' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges |
| frontTexture |
[frontTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode]
Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture
PixelTexture MovieTexture, other texture nodes).
Warning: each child image node must have a different containerField value.
Warning: field originally named 'front' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges |
| leftTexture |
[leftTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode]
Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture
PixelTexture MovieTexture, other texture nodese).
Warning: each child image node must have a different containerField value.
Warning: field originally named 'left' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges |
| rightTexture |
[rightTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode]
Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture
PixelTexture MovieTexture, other texture nodes).
Warning: each child image node must have a different containerField value.
Warning: field originally named 'right' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges |
| topTexture |
[topTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode]
Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture
PixelTexture MovieTexture, other texture nodes).
Warning: each child image node must have a different containerField value.
Warning: field originally named 'top' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges |
| textureProperties |
[textureProperties accessType initializeOnly, type SFNode singleton, NULL node] [TextureProperties]
Single contained TextureProperties node that can specify additional visual attributes
applied to corresponding texture images.
Warning: TextureProperties must follow other textures in order to meet XML validation requirements.
|
| 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). |
| containerField |
[containerField type NMTOKEN "texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
ComposedShader |
(X3D version 3.1 or later) [inherits X3DShaderNode, implements X3DProgrammableShaderObject]
ComposedShader defines a shader where the individual source files are assembled
from contained ShaderPart program sections. All access to shading capabilities is
defined through a single interface that applies to all parts.
Hint: ComposedShader contains field declarations and then corresponding IS/connect statements
(if any), followed by <ShaderPart containerField='parts'/> nodes.
Warning: ComposedShader does not contain CDATA section of plain-text source code. All source
programs are contained in child ShaderPart nodes.
Hint: apply default containerField='shaders' when parent node is Appearance. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| field |
[X3D statement field]
Include a field statement for each field declaration in the ComposedShader node.
|
| parts |
[parts accessType inputOutput, type MFNode array, empty list] [ShaderPart]
ComposedShader can contain multiple ShaderPart nodes in the parts field. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| activate |
[activate accessType inputOnly, type SFBool (true|false)]
activate forces the shader to activate the contained objects.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| isSelected |
[isSelected accessType outputOnly, type SFBool (true|false)]
isSelected indicates this shader instance is selected for use by browser
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isValid |
[isValid accessType outputOnly, type SFBool (true|false)]
isValid indicates whether current shader objects can be run as a shader program.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| language |
[language accessType initializeOnly, type SFString CDATA #IMPLIED]
The language field indicates to the X3D player which shading language is used. The
language field may be used to optionally determine the language type if no MIME-type
information is available.
Hint: recognized values include "Cg" "GLSL" "HLSL". |
| containerField |
[containerField type NMTOKEN "shaders"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
ComposedTexture3D |
(X3D version 3.1 or later) [inherits X3DTexture3DNode]
ComposedTexture3D defines a 3D image-based texture map as a collection of 2D texture
sources at various depths.
Hint: insert 2^n ImageTexture, PixelTexture or MovieTexture child nodes.
The first image is at depth 0 and each following image is at an increasing depth value
in the R direction.
Hint: can contain a single TextureProperties node.
Hint: insert Shape and Appearance nodes before adding texture.
Hint: X3D Architecture 33.2.2 3D texturing concepts https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texture3D.html#3DTextureconcepts
Warning: requires X3D profile='Full' or else include <component name='Texturing3D' level='1'/>
|
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 |
| texture |
[texture accessType inputOutput, type MFNode array, empty list] [X3DTexture2DNode]
collection of 2D texture sources. |
| textureProperties |
[textureProperties accessType initializeOnly, type SFNode singleton, NULL node] [TextureProperties]
Single contained TextureProperties node that can specify additional visual attributes
applied to corresponding texture images. |
| 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 geoto repeat texture along T axis vertically
from top to bottom.metry (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). |
| repeatR |
[repeatR accessType initializeOnly, type SFBool (true|false) "false"]
Whether to repeat texture along R axis from front to back. |
| repeatS |
[repeatS accessType initializeOnly, type SFBool (true|false) "false"]
Whether to repeat texture along S axis horizontally from left to right. |
| repeatT |
[repeatT accessType initializeOnly, type SFBool (true|false) "false"]
Whether to repeat texture along T axis vertically from top to bottom. |
| containerField |
[containerField type NMTOKEN "texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
ComposedVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
ComposedVolumeStyle allows compositing multiple rendering styles into single rendering
pass.
Hint: contains multiple RenderStyle nodes.
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 |
| renderStyle |
[renderStyle accessType inputOutput, type MFNode array, empty list] [X3DComposableVolumeRenderStyleNode]
List of contributing rendering style nodes or node references that can be applied
to the object. Each rendering style is applied strictly in the order declared, starting
with the first rendering style in the renderStyle field. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| ordered |
[ordered accessType inputOutput, type SFBool (true|false) "false"]
If ordered is true, strictly apply each contained renderStyle node in order declared.
|
| containerField |
[containerField type NMTOKEN "renderStyle"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
Cone |
[inherits X3DGeometryNode]
Cone is a geometry node.
Hint: cone https://en.wikipedia.org/wiki/Cone
Hint: insert a Shape node before adding geometry or Appearance. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| height |
[height accessType initializeOnly, type SFFloat CDATA "2"] (0,+β)
Size in meters.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial
creation, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
|
| bottomRadius |
[bottomRadius accessType initializeOnly, type SFFloat CDATA "1"] (0,+β)
Size in meters.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial
creation, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
|
| side |
[side accessType inputOutput, type SFBool (true|false) "true"]
Whether to draw sides (other inside faces are not drawn). |
| bottom |
[bottom accessType inputOutput, type SFBool (true|false) "true"]
Whether to draw bottom (other inside faces are not drawn). |
| 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 |
|
ConeEmitter |
(X3D version 3.2 or later) [inherits X3DParticleEmitterNode]
ConeEmitter generates all available particles from a specific point in space. Particles
are emitted from the single point specified by the position field emanating in a direction
randomly distributed within the cone specified by the angle and direction fields.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| angle |
[angle accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
Cone boundary for random distribution of particles about initial direction.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 1 0"]
Initial direction from which particles emanate. |
| mass |
[mass accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Basic mass of each particle, defined in mass base units (default is kilograms).
Hint: mass is needed if gravity or other force-related calculations are performed on a
per-particle basis.
Hint: https://en.wikipedia.org/wiki/Kilogram
Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates |
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables production of particles from this emitter node. If operating when
turned off, existing particles complete their rendering process. |
| position |
[position accessType inputOutput, type SFVec3f CDATA "0 1 0"]
Point from which particles emanate. |
| speed |
[speed accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
Initial linear speed (default is m/s) imparted to all particles along their direction
of movement. |
| surfaceArea |
[surfaceArea accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Particle surface area in area base units (default is meters squared). Surface area
is used for calculations such as wind effects per particle.
Hint: surfaceArea value represents average frontal area presented to the wind.
Hint: assumes spherical model for each particle (i.e., surface area is the same regardless
of direction). |
| variation |
[variation accessType inputOutput, type SFFloat CDATA "0.25"] [0,+β)
Multiplier for the randomness used to control the range of possible output values.
The bigger the value, the more random the output and the bigger the range of possible
initial values possible.
Hint: variation of zero does not allow any randomness. |
| containerField |
[containerField type NMTOKEN "emitter"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
connect |
[X3D statement]
connect statements define event-routing connections between node fields defined
inside a ProtoBody declaration back to corresponding ProtoInterface fields. To define
each Prototype connection between a ProtoInterface field and a ProtoBody node field,
add one or more connect statements within each IS statement.
Warning: IS/connect elements are only allowed within ProtoDeclare body definitions.
Warning: nodeField and protoField types must match.
Hint: any matching field type can be connected, including SFNode or MFNode.
Hint: if provided, value of the outer ProtoInstance fieldValue overrides default value
of inner IS/connect nodeField (defined within the original prototype declaration)
when first creating a new ProtoInstance node.
Hint: see the IS and ProtoBody statements.
Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PROTOdefinitionsemantics
Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| nodeField |
[nodeField type NMTOKEN #REQUIRED]
Name of field within this node which IS CONNECTed to the ancestor ProtoDeclare field
definition.
Warning: do not define a nodeField connection to an internal DEF, USE, class or containerField,
since they are not fields in a node that can be modified by events at run time.
Warning: do not connect more than one interface protoField to a single field within this
node.
Warning: nodeField and protoField types must match. |
| protoField |
[protoField type NMTOKEN #REQUIRED]
Name of parent ProtoDeclare field definition connecting to field in this node.
Hint: use multiple IS/connect elements for multiple fan-out from a single protoField interface.
Warning: nodeField and protoField types must match. |
| 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 |
|
Contact |
(X3D version 3.2 or later) [inherits X3DNode]
Contact nodes are produced as output events when two collidable objects or spaces
make contact.
Hint: each Contact node contains two RigidBody nodes (containerField='body1' and containerField='body2')
as well as two CollidableShape or CollidableOffset nodes (containerField='geometry1'
and containerField='geometry2').
Warning: Contact nodes are transient and can only occur at run time. It is an error to define
this transient node in an X3D file. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| body1 |
[body1 accessType inputOutput, type SFNode singleton, NULL node] [RigidBody]
The body1 and body2 fields specify two top-level nodes that should be evaluated
in the physics model as a single set of interactions with respect to each other. |
| body2 |
[body2 accessType inputOutput, type SFNode singleton, NULL node] [RigidBody]
The body1 and body2 fields specify two top-level nodes that should be evaluated
in the physics model as a single set of interactions with respect to each other. |
| geometry1 |
[geometry1 accessType inputOutput, type SFNode singleton, NULL node] [X3DNBodyCollidableNode]
The geometry1 and geometry2 fields specify collision-related information about body1
and body2. |
| geometry2 |
[geometry2 accessType inputOutput, type SFNode singleton, NULL node] [X3DNBodyCollidableNode]
The geometry1 and geometry2 fields specify collision-related information about body1
and body2. |
| 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. |
| appliedParameters |
[appliedParameters accessType inputOutput, type MFString CDATA "BOUNCE"]
Default global parameters for collision outputs of rigid body physics system. Contact
node can override parent CollisionCollection node. Selectable values for array: "BOUNCE"
"USER_FRICTION" "FRICTION_COEFFICIENT_2" "ERROR_REDUCTION" "CONSTANT_FORCE" "SPEED_1"
"SPEED_2" "SLIP_1" "SLIP_2".
Hint: BOUNCE: bounce value is used; USER_FRICTION: apply user-supplied value; FRICTION_COEFFICIENT_2:
apply frictionCoefficients values; ERROR_REDUCTION: apply softnessErrorCorrection
value; CONSTANT_FORCE: apply softnessConstantForceMix value; SPEED_1: apply first
component of surfaceSpeed array; SPEED_2: apply second component of surfaceSpeed array;
SLIP_1: apply first component of slipFactors array; SLIP_2: apply second component
of slipFactors array. |
| bounce |
[bounce accessType inputOutput, type SFFloat CDATA "0"] [0,1]
bounce indicates bounciness (0 = no bounce at all, 1 = maximum bounce). |
| contactNormal |
[contactNormal accessType inputOutput, type SFVec3f CDATA "0 1 0"]
contactNormal is unit vector describing normal between two colliding bodies. |
| depth |
[depth accessType inputOutput, type SFFloat CDATA "0"] [0,1]
depth indicates how deep the current intersection is along normal vector. |
| frictionCoefficients |
[frictionCoefficients accessType inputOutput, type SFVec2f CDATA "0 0"]
frictionCoefficients used for computing surface drag. |
| frictionDirection |
[frictionDirection accessType inputOutput, type SFVec3f CDATA "0 1 0"]
frictionDirection controls friction vector.
Hint: value of (0 0 0) indicates no friction. |
| minBounceSpeed |
[minBounceSpeed accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
minBounceSpeed m/s needed to bounce. |
| position |
[position accessType inputOutput, type SFVec3f CDATA "0 0 10"]
position (x, y, z in meters) of exact location of collision. |
| slipCoefficients |
[slipCoefficients accessType inputOutput, type SFVec2f CDATA "0 0"]
slipCoefficients used for computing surface drag. |
| softnessConstantForceMix |
[softnessConstantForceMix accessType inputOutput, type SFFloat CDATA "0"] [0,1]
softnessConstantForceMix value applies a constant force value to make colliding
surfaces appear to be somewhat soft. |
| softnessErrorCorrection |
[softnessErrorCorrection accessType inputOutput, type SFFloat CDATA "0"] [0,1]
softnessErrorCorrection indicates fraction of collision error fixed in a set of
evaluations (0 = no error correction, 1 = all errors corrected in single step). |
| surfaceSpeed |
[surfaceSpeed accessType inputOutput, type SFVec2f CDATA "0 0"]
surfaceSpeed defines speed vectors for computing surface drag, if contact surfaces
move independently of bodies. |
| containerField |
[containerField type NMTOKEN "contacts"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
Contour2D |
[inherits X3DNode]
Contour2D groups a set of curve segments into a composite contour.
The children segments form a closed loop, with first point of first child repeated
as last point of last child, and last point of each segment repeated as the first
point of the next consecutive segment.
The children segments are type NurbsCurve2D or ContourPolyline2D, enumerated in the
consecutive order of contour topology.
Warning: Contour2D is not a renderable geometry node.
Hint: Contour2D is used as the trimmingContour field of the NurbsTrimmedSurface node.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| children |
[children accessType inputOutput, type MFNode array, empty list] [NurbsCurve2D | ContourPolyline2D]
The children form a closed loop with first point of first child repeated as last
point of last child, and the last point of a segment repeated as first point of the
consecutive one.
Hint: children nodes are listed in consecutive order according to topology of the contour.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| containerField |
[containerField type NMTOKEN "trimmingContour"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
ContourPolyline2D |
[inherits X3DNurbsControlCurveNode]
ContourPolyline2D defines a linear curve segment as part of a trimming contour in
the u-v domain of a NURBS surface. NurbsCurve2D and ContourPolyline2D nodes that together
form a closed contour, defined in the u-v parametric space of a NURBS surface, may
be used as children in a Contour2D node.
Warning: ContourPolyline2D is not a renderable geometry node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| controlPoint |
[controlPoint accessType inputOutput, type MFVec2d CDATA #IMPLIED]
controlPoint specifies the end points of each segment of the piecewise linear curve.
|
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
Convolver |
[inherits X3DSoundProcessingNode]
Convolver performs a linear convolution on a given AudioBuffer, often used to achieve
a reverberation effect.
Hint: potential modifications include chorus effects, reverberation, and telephone-like
speech.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#ConvolverNode |
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. |
| 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 |
| 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. |
| normalize |
[normalize accessType inputOutput, type SFBool (true|false) "true"]
normalize controls whether or not the impulse response from the buffer is scaled
by an equal-power normalization when the buffer field is set |
| 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. |
| 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 |
Coordinate |
[inherits X3DCoordinateNode]
Coordinate builds geometry by defining a set of 3D coordinate (triplet) point values.
Coordinate is used by IndexedFaceSet, IndexedLineSet, LineSet, PointSet, Triangle*
and IndexedTriangle* nodes.
Coordinate is also used by HAnimHumanoid, HAnimSegment, and various Nurbs nodes. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| point |
[point accessType inputOutput, type MFVec3f CDATA #IMPLIED]
point contains a set of 3D coordinate (triplet) point values. |
| containerField |
[containerField type NMTOKEN (coord|controlPoint|skinCoord|skinBindingCoords) "coord"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
CoordinateChaser |
(X3D version 3.3 or later) [inherits X3DChaserNode]
CoordinateChaser generates a series of coordinate arrays that progressively change
from initial value to destination value.
Hint: ROUTE value_changed output events to a <Coordinate> node's point field, for example.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 MFVec3f CDATA "0 0 0"]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type MFVec3f CDATA "0 0 0"]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type MFVec3f CDATA #FIXED ""]
set_value resets current value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| set_destination |
[set_destination accessType inputOnly, type MFVec3f CDATA #FIXED ""]
set_destination resets destination value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when follower-node computation starts/stops.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| value_changed |
[value_changed accessType outputOnly, type MFVec3f CDATA #FIXED ""]
Computed output value that approaches within tolerance of destination value, as
determined by elapsed time, order and tau.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
CoordinateDamper |
(X3D version 3.2 or later) [inherits X3DDamperNode]
CoordinateDamper generates a series of coordinate arrays that progressively change
from initial value to destination value.
Hint: ROUTE value_changed output events to a <Coordinate> node's point field, for example.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 MFVec3f CDATA "0 0 0"]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type MFVec3f CDATA "0 0 0"]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type MFVec3f CDATA #FIXED ""]
set_value resets current value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| set_destination |
[set_destination accessType inputOnly, type MFVec3f CDATA #FIXED ""]
set_destination resets destination value of this node.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when follower-node computation starts/stops.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| value_changed |
[value_changed accessType outputOnly, type MFVec3f CDATA #FIXED ""]
Computed output value that approaches within tolerance of destination value, as
determined by elapsed time, order and tau.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
CoordinateDouble |
[inherits X3DCoordinateNode]
CoordinateDouble builds geometry by defining a set of 3D coordinate (triplet) point
values.
CoordinateDouble is used by IndexedFaceSet, IndexedLineSet, LineSet, PointSet, Triangle*
and IndexedTriangle* nodes.
CoordinateDouble is also used by NurbsPositionInterpolator and NurbsOrientationInterpolator.
Warning: CoordinateDouble requires Rendering component level 1, otherwise Full profile. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| point |
[point accessType inputOutput, type MFVec3d CDATA #IMPLIED]
point contains a set of 3D coordinate (triplet) point values. |
| containerField |
[containerField type NMTOKEN (coord|controlPoint|skinCoord|skinBindingCoords) "coord"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
CoordinateInterpolator |
[inherits X3DInterpolatorNode]
CoordinateInterpolator linearly interpolates among a list of 3-tuple MFVec3f arrays,
producing a single MFVec3f array that is fractional average between two nearest arrays
in the list. Authors can ROUTE value_changed output events (an array of 3-tuple SFVec3f
values) to a Coordinate node's point field, or to another MFVec3f field.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction.
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
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.
Hint: number of keyValues must be an integer multiple of the number of keys!
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed
outputOnlys.
Warning: values in key array shall be monotonically non-decreasing, meaning that each value
is greater than or equal to the preceding value.
Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals
can be defined with arbitrary bounds. |
| keyValue |
[keyValue accessType inputOutput, type MFVec3f CDATA #IMPLIED]
Output values for linear interpolation, each corresponding to an input-fraction
value in the key array.
Hint: identical adjacent entries in keyValue array have the effect of defining constant-value
step functions. https://en.wikipedia.org/wiki/Step_function
Hint: number of keyValues must be an integer multiple of the number of keys!
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed
outputOnlys. |
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input key for corresponding keyValue output.
Hint: set_fraction values are typically in same range interval as values in the key array.
Response to an input set_fraction value less than minimum is equivalent to minimum
key, and response to an input set_fraction value greater than maximum is equivalent
to maximum key.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| value_changed |
[value_changed accessType outputOnly, type MFVec3f CDATA #FIXED ""]
Linearly interpolated output value determined by current key time and corresponding
keyValue pair.
Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive
superfluous events that have no effect.
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed
outputOnlys.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
CoordinateInterpolator2D |
[inherits X3DInterpolatorNode]
CoordinateInterpolator2D generates a series of SFVec2f or MFVec2f 2-tuple float
values. Authors can ROUTE value_changed output events to a SFVec2f or MFVec2f attribute.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction.
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='3'/>
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.
Hint: number of keyValues must be an integer multiple of the number of keys!
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed
outputOnlys.
Warning: values in key array shall be monotonically non-decreasing, meaning that each value
is greater than or equal to the preceding value.
Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals
can be defined with arbitrary bounds. |
| keyValue |
[keyValue accessType inputOutput, type MFVec2f CDATA #IMPLIED]
Output values for linear interpolation, each corresponding to an input-fraction
value in the key array.
Hint: identical adjacent entries in keyValue array have the effect of defining constant-value
step functions. https://en.wikipedia.org/wiki/Step_function
Hint: number of keyValues must be an integer multiple of the number of keys!
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed
outputOnlys. |
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input key for corresponding keyValue output.
Hint: set_fraction values are typically in same range interval as values in the key array.
Response to an input set_fraction value less than minimum is equivalent to minimum
key, and response to an input set_fraction value greater than maximum is equivalent
to maximum key.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| value_changed |
[value_changed accessType outputOnly, type MFVec2f CDATA #FIXED ""]
Linearly interpolated output value determined by current key time and corresponding
keyValue pair.
Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive
superfluous events that have no effect.
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed
outputOnlys.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
Cylinder |
[inherits X3DGeometryNode]
Cylinder is a geometry node.
Hint: Cylinder https://en.wikipedia.org/wiki/Cylinder
Hint: insert a Shape node before adding geometry or Appearance. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| height |
[height accessType initializeOnly, type SFFloat CDATA "2"] (0,+β)
Size in meters.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial
creation, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
|
| radius |
[radius accessType initializeOnly, type SFFloat CDATA "1"] (0,+β)
Size in meters.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial
creation, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
|
| top |
[top accessType inputOutput, type SFBool (true|false) "true"]
Whether to draw top (inside faces are never drawn). |
| side |
[side accessType inputOutput, type SFBool (true|false) "true"]
Whether to draw sides (inside faces are never drawn). |
| bottom |
[bottom accessType inputOutput, type SFBool (true|false) "true"]
Whether to draw bottom (inside faces are never drawn). |
| 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 |
CylinderSensor |
[inherits X3DDragSensorNode]
CylinderSensor converts pointer motion (for example, a mouse or wand) into rotation
values
using an invisible cylinder aligned with local Y-axis.
Hint: this sensor detects user interactions affecting peer nodes and their child geometry.
Hint: add semi-transparent surrounding geometry to see the effect of the sensor.
Hint: initial relative bearing of pointer drag determines whether
cylinder sides or end-cap disks are used for manipulation.
Hint: X3D Architecture 20.2.1 Overview of pointing device sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html#OverviewOfPointingDeviceSensors
Hint: X3D Architecture 20.2.2 Drag sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html#DragSensors
Hint: X3D Architecture 20.2.3 Activating and manipulating pointing device sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html#Activatingandmanipulating
Hint: example scenes and authoring assets at https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter08UserInteractivity |
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. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: include space characters since a description is not a DEF identifier. Write short
phrases that make descriptions clear and readable.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| minAngle |
[minAngle accessType inputOutput, type SFFloat CDATA "0"]
clamps rotation_changed events within range of min/max values
Hint: if minAngle > maxAngle, rotation is not clamped.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| maxAngle |
[maxAngle accessType inputOutput, type SFFloat CDATA "0"]
clamps rotation_changed events within range of min/max values
Hint: if minAngle > maxAngle, rotation is not clamped.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| diskAngle |
[diskAngle accessType inputOutput, type SFFloat CDATA "0.262" (15 degrees)]
Help decide rotation behavior from initial relative bearing of pointer drag: acute
angle whether cylinder sides or end-cap disks of virtual-geometry sensor are used
for manipulation.
Hint: diskAngle 0 forces disk-like behavior, diskAngle 1.570796 (90 degrees) forces cylinder-like
behavior. |
| autoOffset |
[autoOffset accessType inputOutput, type SFBool (true|false) "true"]
determines whether previous offset values are remembered/accumulated. |
| axisRotation |
[axisRotation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
axisRotation determines local sensor coordinate system by rotating the local coordinate
system. |
| offset |
[offset accessType inputOutput, type SFFloat CDATA "0"]
Sends event and remembers last value sensed.
Warning: ROUTE connecting rotation_changed to set_offset creates a self-reinforcing positive
feedback loop and results in unmanageable response. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
Select geometry by activating the pointing device (for example, clicking the mouse)
to generate isActive events. Output event isActive=true is sent when geometry is selected
(for example, when primary mouse button is pressed), output event isActive=false is
sent when geometry is deselected (for example, when primary mouse button is released).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isOver |
[isOver accessType outputOnly, type SFBool #FIXED ""]
Hover over geometry by aiming the mouse (or pointing device) to generate isOver
events. Sensor sends output event isOver=true event when pointing device moves over
sensor's geometry, and later sends output event isOver=false event when pointing device
moves off.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| rotation_changed |
[rotation_changed accessType outputOnly, type SFRotation CDATA #FIXED ""]
rotation_changed events equal sum of relative bearing changes plus offset value
about Y-axis in local coordinate system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| trackPoint_changed |
[trackPoint_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
trackPoint_changed events give intersection point of bearing with sensor's virtual
geometry.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events.
Warning: trackPoint_changed events represent unclamped intersection points on plane surface.
Browsers can interpret drags off of the surface in various ways. Note that translation_changed
events are clamped by minPosition/maxPosition and thus may be preferable. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
Delay |
[inherits X3DSoundProcessingNode]
Delay causes a time delay between the arrival of input data and subsequent propagation
to the output.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#DelayNode |
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. |
| delayTime |
[delayTime accessType inputOutput, type SFTime CDATA "0"] [0,+β)
delayTime is duration of delay (in seconds) to apply. |
| maxDelayTime |
[maxDelayTime accessType inputOutput, type SFTime CDATA "0"] [0,+β)
maxDelayTime is duration of maximum amount of delay (in seconds) that can be applied.
|
| 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. |
| 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 |
DirectionalLight |
[inherits X3DLightNode]
DirectionalLight defines parallel light rays that illuminate geometric shapes.
Lighting illuminates all geometry except lines and points. By default, light scope
only illuminates peer geometry and children nodes within the scene graph hierarchy.
No source location is needed since rays are parallel from an infinitely distant source.
DirectionalLight nodes do not attenuate with distance.
Lights have no visible shape themselves and lighting effects continue through any
intermediate geometry.
Hint: animate direction to simulate time-of-day sunlight effects.
Hint: the bound NavigationInfo controls whether headlight is enabled on/off.
Interchange profile
Hint: light might not be scoped by parent Group or Transform. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables this light source. |
| color |
[color accessType inputOutput, type SFColor CDATA "1 1 1"] [0,1]
color of light, applied to colors of objects.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 0 -1"]
Orientation vector of light relative to local coordinate system.
Hint: animate direction to simulate time-of-day sunlight effects. |
| global |
(X3D version 3.1 or later) [global accessType inputOutput, type SFBool (true|false) "false"]
Global lights illuminate all objects within their volume of lighting influence.
Scoped lights only illuminate objects within the same transformation hierarchy.
Warning: DirectionalLight default global=false to limit scope and avoid inadvertently illuminating
every object in a large scene. PointLight and SpotLight default global=true since
their effects are each limited by maximum radius value. |
| intensity |
[intensity accessType inputOutput, type SFFloat CDATA "1"] [0,+β]
Brightness of direct emission from the light. |
| ambientIntensity |
[ambientIntensity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
Brightness of ambient (nondirectional background) emission from the light. Interchange
profile
Hint: this field may be ignored, applying the default value regardless. |
| shadowIntensity |
[shadowIntensity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
shadowIntensity field defines how much light is obscured by shapes that cast shadows,
ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured,
full-intensity shadows). |
| shadows |
[shadows accessType inputOutput, type SFBool (true|false) "false"]
shadows field indicates whether or not this light casts a shadow behind illuminated
X3DShapeNode geometry. |
| 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 |
DISEntityManager |
[inherits X3DChildNode]
DISEntityManager notifies a scene when new DIS ESPDU entities arrive or current
entities leave. DISEntityManager may contain any number of DISEntityTypeMapping nodes
that provide a best-match X3D model to incoming entity type values. For each new DIS
entity, DISEntityManager thus produces a new EspduTransform node that contains a corresponding
X3D model.
Hint: DISEntityManager contains DISEntityTypeMapping nodes.
Hint: DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS)
protocol.
Warning: 'children' field originally named 'mapping' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
Hint: Savage Developers Guide on DIS https://savage.nps.edu/Savage/developers.html#DIS
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/> |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| children |
[children accessType inputOutput, type MFNode array, empty list] [DISEntityTypeMapping]
mapping field provides a mechanism for automatically creating an X3D model when
a new entity arrives over the network. If a new entity matches one of the nodes, an
instance of the provided URL is created and added as a child to the EspduTransform
specified in the addedEntities field.
Hint: multiple DISEntityTypeMapping nodes can be provided in mapping field, best match
takes precedence.
Warning: field originally named 'mapping' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges |
| addedEntities |
[addedEntities accessType outputOnly, type MFNode array] [EspduTransform]
addedEntities array contains any new entities added during the last frame.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| removedEntities |
[removedEntities accessType outputOnly, type MFNode array] [EspduTransform]
removedEntities output array provides EspduTransform references to any entities
removed during last frame, either due to a timeout or from an explicit RemoveEntityPDU
action.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| address |
[address accessType inputOutput, type SFString CDATA localhost]
Multicast network address, or else 'localhost'.
Example: 224.2.181.145. |
| port |
[port accessType inputOutput, type SFInt32 CDATA "0"]
Multicast network port, for example: 3000. |
| applicationID |
[applicationID accessType inputOutput, type SFInt32 CDATA "0"]
Each simulation application that can respond to simulation management PDUs needs
to have a unique applicationID. |
| siteID |
[siteID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise siteID of the participating LAN or organization. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
DISEntityTypeMapping |
[inherits X3DInfoNode, implements X3DUrlObject]
DISEntityTypeMapping provides a best-match mapping from DIS ESPDU entity type information
to a specific X3D model, thus providing a visual and behavioral representation that
best matches the entity type. Fields are processed in order: kind, domain, country,
category, subcategory, specific, extra.
Hint: values set to zero are wildcards, matching any received value.
Hint: DISEntityTypeMapping is contained by a parent DISEntityManager node.
Hint: DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS)
protocol.
Hint: Savage Developers Guide on DIS https://savage.nps.edu/Savage/developers.html#DIS
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/>
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). |
| 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. |
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Local and/or online addresses of X3D model of interest, for example: "ExtrusionExampleShip.x3d"
"https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d"
Hint: see https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html
Hint: MFString arrays can have multiple values, so separate each individual string by
quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
Hint: alternative XML encoding for quotation mark " is " (which is an example of
a character entity).
Warning: strictly match directory and filename capitalization for http links! This is important
for portability. Some operating systems are forgiving of capitalization mismatches,
but http/https url addresses and paths in Unix-based operating systems are all case
sensitive and intolerant of uppercase/lowercase mismatches.
Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls |
| kind |
[kind accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM,
ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER.
|
| domain |
[domain accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE,
SUBSURFACE, SPACE or OTHER. |
| country |
[country accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for country to which the design of the entity or its
design specification is attributed. |
| category |
[category accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for main category that describes the entity, semantics
of each code varies according to domain. See DIS Enumerations values. |
| subcategory |
[subcategory accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for particular subcategory to which an entity belongs
based on the category field. See DIS Enumerations values. |
| specific |
[specific accessType inputOutput, type SFInt32 CDATA "0"]
Specific information about an entity based on the subcategory field. See DIS Enumerations
values. |
| extra |
[extra accessType inputOutput, type SFInt32 CDATA "0"]
Any extra information required to describe a particular entity. The contents of
this field shall depend on the type of entity represented. |
| containerField |
[containerField type NMTOKEN (children|mapping|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 |
Disk2D |
[inherits X3DGeometryNode]
Disk2D is a geometry node that defines a filled (or partially filled) planar circle
with center (0,0).
Hint: insert a Shape node before adding geometry or Appearance.
Warning: requires X3D profile='Full' or else include <component name='Geometry2D' level='2'/>
Examples: X3D Example Archives, X3D for Web Authors, Chapter 10 Geometry 2D https://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. |
| innerRadius |
[innerRadius accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Inner circle radius, greater than or equal to 0.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial
creation, avoiding the need for potentially expensive tessellation at run time.
Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
|
| outerRadius |
[outerRadius accessType initializeOnly, type SFFloat CDATA "1"] (0,+β)
Outer radius of circle, greater than or equal to inner radius.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial
creation, 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 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 |
DoubleAxisHingeJoint |
(X3D version 3.2 or later) [inherits X3DRigidJointNode]
DoubleAxisHingeJoint has two independent axes located around a common anchor point.
axis1 has limits and a motor, axis 2 only has a motor
Contains two RigidBody nodes (containerField values body1, body2).
Hint: RigidBodyPhysics component, level 2. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| 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. |
| axis1 |
[axis1 accessType inputOutput, type SFVec3f CDATA "1 0 0"]
axis1 defines axis vector of joint connection to body1.
Hint: 0 0 0 means motor disabled about this axis. |
| axis2 |
[axis2 accessType inputOutput, type SFVec3f CDATA "0 1 0"]
axis2 defines axis vector of joint connection to body2.
Hint: 0 0 0 means motor disabled about this axis. |
| desiredAngularVelocity1 |
[desiredAngularVelocity1 accessType inputOutput, type SFFloat CDATA "0"]
desiredAngularVelocity1 is goal rotation rate for hinge connection to body1. |
| desiredAngularVelocity2 |
[desiredAngularVelocity2 accessType inputOutput, type SFFloat CDATA "0"]
desiredAngularVelocity2 is goal rotation rate for hinge connection to body2. |
| forceOutput |
[forceOutput accessType inputOutput, type MFString CDATA "NONE"]
forceOutput controls which output fields are generated for the next frame. Values
are ALL, NONE, or exact names of output fields updated at start of next frame. |
| minAngle1 |
[minAngle1 accessType inputOutput, type SFFloat CDATA "-3.1416"] [-Ο,Ο]
minAngle1 is minimum rotation angle for hinge. |
| maxAngle1 |
[maxAngle1 accessType inputOutput, type SFFloat CDATA "3.1416"] [-Ο,Ο]
maxAngle1 is maximum rotation angle for hinge. |
| maxTorque1 |
[maxTorque1 accessType inputOutput, type SFFloat CDATA "0"]
maxTorque1 is maximum rotational torque applied by corresponding motor axis to achieve
desiredAngularVelocity1. |
| maxTorque2 |
[maxTorque2 accessType inputOutput, type SFFloat CDATA "0"]
maxTorque2 is maximum rotational torque applied by corresponding motor axis to achieve
desiredAngularVelocity2. |
| stop1Bounce |
[stop1Bounce accessType inputOutput, type SFFloat CDATA "0"] [0,1]
stop1Bounce is velocity factor for bounce back once stop point is reached.
Hint: 0 means no bounce, 1 means return velocity matches. |
| stop1ErrorCorrection |
[stop1ErrorCorrection accessType inputOutput, type SFFloat CDATA "0.8"] [0,1]
stop1ErrorCorrection is fraction of error correction performed during time step
once stop point is reached.
Hint: 0 means no error correction, 1 means all error corrected in single step. |
| stop1ConstantForceMix |
[stop1ConstantForceMix accessType inputOutput, type SFFloat CDATA "0.001"] [0,1]
stop1ConstantForceMix value applies a constant force value to make colliding surfaces
appear to be somewhat soft.
Hint: use with suspensionForce to improve softness and numerical stability.
Hint: 0 means no stop adjustment, 1 means springier stop response. |
| suspensionErrorCorrection |
[suspensionErrorCorrection accessType inputOutput, type SFFloat CDATA "0.8"] [0,1]
suspensionErrorCorrection describes how quickly the system resolves intersection
errors due to floating-point inaccuracies.
Hint: use with stop1ConstantForceMix to improve softness and numerical stability.
Hint: 0 means no stop adjustment, 1 means springier stop response. |
| suspensionForce |
[suspensionForce accessType inputOutput, type SFFloat CDATA "0.8"] [0,1]
suspensionForce describes how quickly the system resolves intersection errors due
to floating-point inaccuracies.
Hint: use with stop1ConstantForceMix to improve softness and numerical stability.
Hint: 0 means no stop adjustment, 1 means springier stop response. |
| 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. |
| body1Axis |
[body1Axis accessType outputOnly, type SFVec3f CDATA]
body1Axis describes report the current location of the anchor point relative to
the corresponding body. This can be used to determine if the joint has broken.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| body2Axis |
[body2Axis accessType outputOnly, type SFVec3f CDATA]
body1Axis describes report the current location of the anchor point relative to
the corresponding body. This can be used to determine if the joint has broken.
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 |
|
DynamicsCompressor |
[inherits X3DSoundProcessingNode]
DynamicsCompressor node implements a dynamics compression effect, lowering volume
of loudest parts of signal and raising volume of softest parts.
Hint: W3C Web Audio API w3.org/TR/webaudio/#dynamicscompressornode |
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. |
| attack |
[attack accessType inputOutput, type SFTime CDATA "0.003"] [0,+β)
The attack field is the duration of time (in seconds) to reduce the gain by 10dB.
|
| 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. |
| knee |
[knee accessType inputOutput, type SFFloat CDATA "30"] [0,+β)
knee field contains a decibel value representing range above threshold where the
curve smoothly transitions to compressed portion. |
| ratio |
[ratio accessType inputOutput, type SFFloat CDATA "30"] [0,+β)
ratio field represents amount of input change, in dB, needed for 1 dB change in
output. |
| reduction |
[reduction accessType outputOnly, type SFFloat CDATA #FIXED ""] [0,+β)
reduction field provides amount of gain reduction in dB currently applied by compressor
to signal. If fed no signal, then value is 0 (no gain reduction) |
| release |
[release accessType inputOutput, type SFTime CDATA "0"] [0,+β)
release field represents amount of time (in seconds) to increase gain by 10dB. |
| threshold |
[threshold accessType inputOutput, type SFFloat CDATA "30"] [0,+β)
threshold field represents decibel value above which compression starts taking effect.
|
| 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. |
| 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. |
| 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 |
EaseInEaseOut |
(X3D version 3.2 or later) [inherits X3DNode]
EaseInEaseOut enables gradual animation transitions by modifying TimeSensor fraction
outputs.
Output values are modified fractions. Authors can ROUTE value_changed output events
to an interpolator, a sequencer, or another SFFloat attribute.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisEaseInEaseOutDEF.set_fraction
Hint: typical output connection is ROUTE thisEaseInEaseOutDEF.modifiedFraction_changed
TO someDestinationNodeDEF.set_fraction.
Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='3'/>
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 easeInEaseOut array.
Hint: number of keys must be one more than the number of easeInEaseOut values!
Warning: values in key array shall be monotonically non-decreasing, meaning that each value
is greater than or equal to the preceding value.
Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals
can be defined with arbitrary bounds. |
| easeInEaseOut |
[easeInEaseOut accessType inputOutput, type MFVec2f CDATA #IMPLIED]
Array of paired values for easeOut fraction and easeIn fraction within each key
interval.
Hint: number of easeInEaseOut values must be one less than the number of keys. |
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input fraction for computation of corresponding easeInEaseOut
output value, modifiedFraction_changed.
Hint: set_fraction values are typically in same range interval as values in the key array.
Response to an input set_fraction value less than minimum is equivalent to minimum
key, and response to an input set_fraction value greater than maximum is equivalent
to maximum key.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| modifiedFraction_changed |
[modifiedFraction_changed accessType outputOnly, type SFFloat CDATA #FIXED ""]
Interpolated output value determined by current key time, corresponding easeInEaseOut
smoothing intervals, and corresponding key pair.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
EdgeEnhancementVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
EdgeEnhancementVolumeStyle specifies edge enhancement for the volume rendering style.
Hint: surfaceNormals can be provided in a single ComposedTexture3D, ImageTexture3D or
PixelTexture3D node.
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. |
| gradientThreshold |
[gradientThreshold accessType inputOutput, type SFFloat CDATA "0.4"] [0,1]
minimum angle (in radians) away from view-direction vector for surface normal before
applying enhancement |
| edgeColor |
[edgeColor accessType inputOutput, type SFColorRGBA CDATA "0 0 0 1"] [0,1]
color used to highlight edges.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| containerField |
[containerField type NMTOKEN "renderStyle"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
ElevationGrid |
[inherits X3DGeometryNode]
ElevationGrid is a geometry node defining a rectangular height field, with default
values for a 1m by 1m square at height 0.
Vertices corresponding to ElevationGrid height values define quadrilaterals, which
are placed above or below a flat surface.
Hint: the height array defines (xDimension-1)*(zDimension-1) quadrilaterals.
Warning: generated quadrilaterals can be nonplanar. Tessellation splits quadrilaterals into
triangles along seam starting at initial vertex of the quadrilateral and proceeding
to opposite vertex.
Hint: positive direction for normal of each triangle is on same side of the quadrilateral.
Triangles are defined either counterclockwise or clockwise depending on value of ccw
field.
Hint: ElevationGrid can contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorPerVertex field. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate
node that can specify coordinates for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| xDimension |
[xDimension accessType initializeOnly, type SFInt32 CDATA "0"] (0,+β)
Number of elements in the height array along X direction.
Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
Warning: xDimension < 2 means that ElevationGrid contains no quadrilaterals. |
| zDimension |
[zDimension accessType initializeOnly, type SFInt32 CDATA "0"] (0,+β)
Number of elements in the height array along Z direction.
Hint: total horizontal z-axis distance equals (zDimension-1) * zSpacing.
Warning: zDimension < 2 means that ElevationGrid contains no quadrilaterals. |
| xSpacing |
[xSpacing accessType initializeOnly, type SFFloat CDATA "1.0"] (0,+β)
Meters distance between grid-array vertices along X direction.
Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing. |
| zSpacing |
[zSpacing accessType initializeOnly, type SFFloat CDATA "1.0"] (0,+β)
Meters distance between grid-array vertices along Z direction.
Hint: total lateral z-axis distance equals (zDimension-1) * zSpacing. |
| height |
[height accessType initializeOnly, type MFFloat CDATA ""]
Grid array of height vertices with upward direction along +Y axis, with xDimension
rows and zDimension columns.
Hint: height array values are given in row-major order from left to right along X axis,
then back to front along Z axis.
Warning: height array values are not retained or available at run time since a browser is
permitted to condense geometry.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| set_height |
[set_height accessType inputOnly, type MFFloat CDATA #FIXED ""]
Grid array of height vertices with upward direction along +Y axis, with xDimension
rows and zDimension columns.
Hint: height array values are given in row-major order from left to right along X axis,
then back to front along Z axis.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| creaseAngle |
[creaseAngle accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
creaseAngle defines angle (in radians) for determining whether adjacent polygons
are drawn with sharp edges or smooth shading. If angle between normals of two adjacent
polygons is less than creaseAngle, smooth shading is rendered across the shared line
segment.
Hint: creaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all
edges smoothly.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| solid |
[solid accessType initializeOnly, type SFBool (true|false) "true"]
Setting solid true means draw only one side of polygons (backface culling on), setting
solid false means draw both sides of polygons (backface culling off).
Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a
brick).
Warning: default value true can completely hide geometry if viewed from wrong side!
Hint: if in doubt, use solid='false' for maximum visibility.
Hint: accessType relaxed to inputOutput in order to support animation and visualization.
|
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color node color values are applied to each point vertex (true) or per quadrilateral
(false).
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or per
quadrilateral (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. |
| containerField |
[containerField type NMTOKEN "geometry"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
EspduTransform |
[inherits X3DGroupingNode, implements X3DNetworkSensorNode, X3DVisibleObject]
EspduTransform is a networked Transform node that can contain most nodes. If activated,
EspduTransform can send or receive Entity State Protocol Data Unit (PDU) packets,
also integrating functionality for the following DIS PDUs: EntityStatePdu, CollisionPdu,
DetonatePdu, FirePdu, CreateEntity and RemoveEntity PDUs.
Hint: these PDU packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
Hint: Savage Developers Guide on DIS https://savage.nps.edu/Savage/developers.html#DIS
Hint: insert a Shape node before adding geometry or Appearance.
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
Warning: requires X3D profile='Full' or else include <component name='DIS' level='1'/> |
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. |
| 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 the sensor node. |
| marking |
[marking accessType inputOutput, type SFString CDATA #IMPLIED]
Maximum of 11 characters for simple entity label. |
| entityID |
[entityID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise entityID is a unique ID for a single entity within that application.
|
| applicationID |
[applicationID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise applicationID is unique for application at that site. Each simulation
application that can respond to simulation management PDUs needs to have a unique
applicationID. |
| siteID |
[siteID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise siteID of the participating LAN or organization. |
| forceID |
[forceID accessType inputOutput, type SFInt32 CDATA "0"]
forceID determines the team membership of the issuing entity, and whether FRIENDLY
OPPOSING or NEUTRAL or OTHER. |
| entityKind |
[entityKind accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM,
ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER.
|
| entityDomain |
[entityDomain accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE,
SUBSURFACE, SPACE or OTHER. |
| entityCountry |
[entityCountry accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for country to which the design of the entity or its
design specification is attributed. |
| entityCategory |
[entityCategory accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for main category that describes the entity, semantics
of each code varies according to domain. See DIS Enumerations values. |
| entitySubcategory |
[entitySubcategory accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for particular subcategory to which an entity belongs
based on the category field. See DIS Enumerations values. |
| entitySpecific |
[entitySpecific accessType inputOutput, type SFInt32 CDATA "0"]
Specific information about an entity based on the Subcategory field. See DIS Enumerations
values. |
| entityExtra |
[entityExtra accessType inputOutput, type SFInt32 CDATA "0"]
Any extra information required to describe a particular entity. The contents of
this field shall depend on the type of entity represented. |
| readInterval |
[readInterval accessType inputOutput, type SFTime CDATA "0.1"] [0,+β)
Seconds between read updates, 0 means no reading.
Hint: readInterval is a nonnegative SFTime duration interval, not an absolute clock time.
|
| writeInterval |
[writeInterval accessType inputOutput, type SFTime CDATA "1.0"] [0,+β)
Seconds between write updates, 0 means no writing (sending).
Hint: writeInterval is a nonnegative SFTime duration interval, not an absolute clock time.
|
| networkMode |
[networkMode accessType inputOutput, type SFString CDATA ( standAlone|networkReader|networkWriter ) standAlone]
Whether this entity is ignoring the network, sending DIS packets to the network,
or receiving DIS packets from the network. (1) standAlone: ignore network but still
respond to events in local scene. (2) networkReader: listen to network and read PDU
packets at readInterval, act as remotely linked copy of entity. (3) networkWriter:
send PDU packets to network at writeInterval, act as master entity. Default value
"standAlone" ensures that DIS network activation within a scene as networkReader or
networkWriter is intentional.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values.
Warning: network activity may have associated security issues. |
| isStandAlone |
[isStandAlone accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='local' (ignore network but still respond to local events).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isNetworkReader |
[isNetworkReader accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='remote' (listen to network as copy of remote entity).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isNetworkWriter |
[isNetworkWriter accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='master' (output to network as master entity at writeInterval).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| address |
[address accessType inputOutput, type SFString CDATA localhost]
Multicast network address, or else 'localhost';
Example: 224.2.181.145. |
| port |
[port accessType inputOutput, type SFInt32 CDATA "0"]
Network connection port number (EXAMPLE 3000) for sending or receiving DIS messages.
Example: 3000. |
| multicastRelayHost |
[multicastRelayHost accessType inputOutput, type SFString CDATA #IMPLIED]
Fallback server address if multicast not available locally.
Example: track.nps.edu. |
| multicastRelayPort |
[multicastRelayPort accessType inputOutput, type SFInt32 CDATA "0"]
Fallback server port if multicast not available locally.
Example: 8010. |
| rtpHeaderExpected |
[rtpHeaderExpected accessType inputOutput, type SFBool (true|false) "false"]
Whether RTP headers are prepended to DIS PDUs. |
| isRtpHeaderHeard |
[isRtpHeaderHeard accessType outputOnly, type SFBool #FIXED ""]
Whether incoming DIS packets have an RTP header prepended.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
Have we received a network update recently?
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| timestamp |
[timestamp accessType outputOnly, type SFTime CDATA #FIXED ""]
DIS timestamp received from latest PDU update, converted to X3D SFTime units.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| translation |
[translation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position of children relative to local coordinate system, usually read from (or
written to) remote, networked EspduTransform nodes. |
| rotation |
[rotation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Orientation of children relative to local coordinate system, usually read from (or
written to) remote, networked EspduTransform nodes. |
| center |
[center accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Translation offset from origin of local coordinate system. |
| 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.
|
| scaleOrientation |
[scaleOrientation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Preliminary rotation of coordinate system before scaling (to allow scaling around
arbitrary orientations). |
| 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. |
| linearVelocity |
[linearVelocity accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Velocity of the entity relative to the rotating Earth in either world or entity coordinates,
depending on the dead reckoning algorithm used. |
| linearAcceleration |
[linearAcceleration accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Acceleration of the entity relative to the rotating Earth in either world or entity
coordinates, depending on the dead reckoning algorithm used. |
| deadReckoning |
[deadReckoning accessType inputOutput, type SFInt32 CDATA "0"]
Dead reckoning algorithm being used to project position/orientation with velocities/accelerations.
|
| isCollided |
[isCollided accessType outputOnly, type SFBool #FIXED ""]
Has a matching CollisionPDU reported a collision?
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 ""]
When were we collided with?
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isDetonated |
[isDetonated accessType outputOnly, type SFBool #FIXED ""]
Has a matching DetonationPDU reported a detonation?
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| detonateTime |
[detonateTime accessType outputOnly, type SFTime CDATA #FIXED ""]
When were we detonated? |
| fired1 |
[fired1 accessType inputOutput, type SFBool (true|false) "false"]
Has the primary weapon (Fire PDU) been fired? |
| fired2 |
[fired2 accessType inputOutput, type SFBool (true|false) "false"]
Has the secondary weapon (Fire PDU) been fired? |
| fireMissionIndex |
[fireMissionIndex accessType inputOutput, type SFInt32 CDATA #FIXED ""]
|
| firedTime |
[firedTime accessType outputOnly, type SFTime CDATA #FIXED ""]
When did we shoot a weapon (Fire PDU)?
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| munitionStartPoint |
[munitionStartPoint accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Initial point of the munition path from firing weapon to detonation or impact, in
exercise coordinates. |
| munitionEndPoint |
[munitionEndPoint accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Final point of the munition path from firing weapon to detonation or impact, in
exercise coordinates. |
| munitionEntityID |
[munitionEntityID accessType inputOutput, type SFInt32 CDATA "0"]
munitionEntityID is unique ID for entity firing munition within that application.
|
| munitionApplicationID |
[munitionApplicationID accessType inputOutput, type SFInt32 CDATA "1"]
munitionApplicationID, unique for application at that site. Each simulation application
that can respond to simulation management PDUs needs to have a unique applicationID.
|
| munitionSiteID |
[munitionSiteID accessType inputOutput, type SFInt32 CDATA "0"]
Munition siteID of the participating LAN or organization. |
| warhead |
[warhead accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for type of warhead on the munition. |
| fuse |
[fuse accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for type of fuse on the munition. |
| munitionQuantity |
[munitionQuantity accessType inputOutput, type SFInt32 CDATA "0"]
Quantity of munitions fired. |
| firingRate |
[firingRate accessType inputOutput, type SFInt32 CDATA "0"]
Rate at which munitions are fired. |
| firingRange |
[firingRange accessType inputOutput, type SFFloat CDATA "0"]
Range (three dimension, straight-line distance) that the firing entity's fire control
system has assumed for computing the fire control solution if a weapon and if the
value is known |
| collisionType |
[collisionType accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumeration for type of collision: ELASTIC or INELASTIC. |
| detonationLocation |
[detonationLocation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
World coordinates for detonationLocation |
| detonationRelativeLocation |
[detonationRelativeLocation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Relative coordinates for detonation location |
| detonationResult |
[detonationResult accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumeration for type of detonation and result that occurred., if any. |
| eventApplicationID |
[eventApplicationID accessType inputOutput, type SFInt32 CDATA "1"]
Simulation/exercise eventApplicationID is unique for events generated from application
at that site. Each simulation application that can respond to simulation management
PDUs needs to have a unique applicationID. |
| eventEntityID |
[eventEntityID accessType inputOutput, type SFInt32 CDATA "0"]
For a given event, simulation/exercise entityID is a unique ID for a single entity
within that application. |
| eventNumber |
[eventNumber accessType inputOutput, type SFInt32 CDATA "0"]
Sequential number of each event issued by an application.
Warning: reuse of numbers may be necessary during long simulation exercises. |
| eventSiteID |
[eventSiteID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise siteID of the participating LAN or organization. |
| articulationParameterCount |
[articulationParameterCount accessType inputOutput, type SFInt32 CDATA "0"]
Number of articulated parameters attached to this entity state PDU. |
| articulationParameterDesignatorArray |
[articulationParameterDesignatorArray accessType inputOutput, type MFInt32 CDATA #IMPLIED]
Array of designators for each articulated parameter. |
| articulationParameterChangeIndicatorArray |
[articulationParameterChangeIndicatorArray accessType inputOutput, type MFInt32 CDATA #IMPLIED]
Array of change counters, each incremented when an articulated parameter is updated.#IMPLIED]
|
| articulationParameterIdPartAttachedToArray |
[articulationParameterIdPartAttachedToArray accessType inputOutput, type MFInt32 CDATA #IMPLIED]
Array of ID parts that each articulated parameter is attached to. |
| articulationParameterTypeArray |
[articulationParameterTypeArray accessType inputOutput, type MFInt32 CDATA #IMPLIED]
Array of type enumerations for each articulated parameter element. |
| articulationParameterArray |
[articulationParameterArray accessType inputOutput, type MFFloat CDATA #IMPLIED]
Information required for representation of the entity's visual appearance and position
of its articulated parts.
Hint: renamed as Variable Parameter in IEEE DIS 2012 revised standard. |
| set_articulationParameterValue0 |
[set_articulationParameterValue0 accessType inputOnly, type SFFloat CDATA #FIXED ""]
Set element of user-defined payload array.
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_articulationParameterValue1 |
[set_articulationParameterValue1 accessType inputOnly, type SFFloat CDATA #FIXED ""]
Set element of user-defined payload array.
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_articulationParameterValue2 |
[set_articulationParameterValue2 accessType inputOnly, type SFFloat CDATA #FIXED ""]
Set element of user-defined payload array.
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_articulationParameterValue3 |
[set_articulationParameterValue3 accessType inputOnly, type SFFloat CDATA #FIXED ""]
Set element of user-defined payload array.
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_articulationParameterValue4 |
[set_articulationParameterValue4 accessType inputOnly, type SFFloat CDATA #FIXED ""]
Set element of user-defined payload array.
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_articulationParameterValue5 |
[set_articulationParameterValue5 accessType inputOnly, type SFFloat CDATA #FIXED ""]
Set element of user-defined payload array.
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_articulationParameterValue6 |
[set_articulationParameterValue6 accessType inputOnly, type SFFloat CDATA #FIXED ""]
Set element of user-defined payload array.
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_articulationParameterValue7 |
[set_articulationParameterValue7 accessType inputOnly, type SFFloat CDATA #FIXED ""]
Set element of user-defined payload array.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| articulationParameterValue0_changed |
[articulationParameterValue0_changed accessType outputOnly, type SFFloat CDATA #FIXED ""]
Get element of user-defined payload array.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| articulationParameterValue1_changed |
[articulationParameterValue1_changed accessType outputOnly, type SFFloat CDATA #FIXED ""]
Get element of user-defined payload array.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| articulationParameterValue2_changed |
[articulationParameterValue2_changed accessType outputOnly, type SFFloat CDATA #FIXED ""]
Get element of user-defined payload array. |
| articulationParameterValue3_changed |
[articulationParameterValue3_changed accessType outputOnly, type SFFloat CDATA #FIXED ""]
Get element of user-defined payload array.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| articulationParameterValue4_changed |
[articulationParameterValue4_changed accessType outputOnly, type SFFloat CDATA #FIXED ""]
Get element of user-defined payload array.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| articulationParameterValue5_changed |
[articulationParameterValue5_changed accessType outputOnly, type SFFloat CDATA #FIXED ""]
Get element of user-defined payload array.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| articulationParameterValue6_changed |
[articulationParameterValue6_changed accessType outputOnly, type SFFloat CDATA #FIXED ""]
Get element of user-defined payload array.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| articulationParameterValue7_changed |
[articulationParameterValue7_changed accessType outputOnly, type SFFloat CDATA #FIXED ""]
Get element of user-defined payload array.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| geoCoords |
(X3D version 3.3 or later) [geoCoords accessType inputOutput, type SFVec3d CDATA "0 0 0"]
Geographic location (specified in current geoSystem coordinates) for children geometry
(specified in relative coordinate system, in meters).
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'/>
|
| geoSystem |
(X3D version 3.3 or later) [geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| 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 |
|
ExplosionEmitter |
(X3D version 3.2 or later) [inherits X3DParticleEmitterNode]
ExplosionEmitter generates all particles from a specific point in space at the initial
time enabled. |
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. |
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables production of particles from this emitter node. If operating when
turned off, existing particles complete their rendering process. |
| position |
[position accessType inputOutput, type SFVec3f CDATA "0 1 0"]
Point from which particles emanate. |
| mass |
[mass accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Basic mass of each particle, defined in mass base units (default is kilograms).
Hint: mass is needed if gravity or other force-related calculations are performed on a
per-particle basis.
Hint: https://en.wikipedia.org/wiki/Kilogram
Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates |
| speed |
[speed accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
Initial linear speed (default is m/s) imparted to all particles along their direction
of movement. |
| surfaceArea |
[surfaceArea accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Particle surface area in area base units (default is meters squared). Surface area
is used for calculations such as wind effects per particle.
Hint: surfaceArea value represents average frontal area presented to the wind.
Hint: assumes spherical model for each particle (i.e., surface area is the same regardless
of direction). |
| variation |
[variation accessType inputOutput, type SFFloat CDATA "0.25"] [0,+β)
Multiplier for the randomness used to control the range of possible output values.
The bigger the value, the more random the output and the bigger the range of initial
values possible.
Hint: variation of zero does not allow any randomness. |
| containerField |
[containerField type NMTOKEN "emitter"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
EXPORT |
[X3D statement]
EXPORT exposes a single local node for external ROUTE passing of event values when
the current Scene is included via Inline by a parent external world. These connections
allow event values to be exchanged via ROUTE statements between a parent model and
a child Inline model.
Hint: you can place EXPORT statements after Scene tag to show interfaces at top, or you
can define it adjacent to the node of interest.
Hint: see IMPORT statement for corresponding functionality in the parent external world.
Warning: EXPORT statements are not allowed in prototype declarations.
Warning: corresponding parent-scene IMPORT and child Inline-scene EXPORT statements are
necessary in order to ROUTE values between a parent model and a child Inline model.
Warning: node types must match.
Hint: Inline EXPORT example:https://www.web3d.org/x3d/content/examples/Basic/X3dSpecifications/InlineExportIndex.html
Hint: Inline IMPORT example:https://www.web3d.org/x3d/content/examples/Basic/X3dSpecifications/InlineImportIndex.html
Hint: X3D Architecture 4.4.6 Import/Export semantics https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#ImportExportsemantics
Hint: X3D XML Encoding, 4.3.12 IMPORT/EXPORT statement syntax https://web3d.org/specifications/X3Dv4Draft/ISO-IEC19776-1v4.0-WD1/Part01/concepts.html#IMPORT_EXPORTStatementSyntax |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| localDEF |
[localDEF type IDREF #REQUIRED]
localDEF is the DEF name of the local node to be EXPORTed. |
| AS |
#IMPLIED]
rename localDEF node AS a different name when exporting.
Hint: optional, default is to use same localDEF name. |
| 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 |
ExternProtoDeclare |
[X3D statement]
ExternProtoDeclare refers to a ProtoDeclare node declaration provided in another
file.
ExternProtoDeclare interfaces are defined by <field> statements (without IS/connect
statements).
Hint: ExternProtoDeclare is a definition only, add corresponding ProtoInstance nodes to
create new instances.
Hint: ExternProtoDeclare url is of the form
https://www.web3d.org/x3d/someWorld.x3d#ProtoName
Hint: X3D Scene Authoring Hints, Inlines and Prototypes https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#InlinesPrototypes
Warning: do not include a <ProtoInterface> element.
Warning: setting a value is not allowed for ExternProtoDeclare field declarations, since
original ProtoDeclare initializations or local ProtoInstance fieldValue initializations
take precedence.
Hint: X3D Architecture 7.2.5.9 EXTERNPROTO statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#EXTERNPROTOStatement
Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PROTOdefinitionsemantics
Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| field |
[X3D statement field]
Include a field statement for each field declaration in the corresponding original
ProtoDeclare.
Warning: do not include initialization values in these field declarations since the original
ProtoDeclare takes precedence. |
| name |
[name type NMTOKEN #REQUIRED]
name of the ExternProtoDeclare (External Prototype Declaration) being referenced.
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 |
| url |
[url accessType initializeOnly, type MFString CDATA #IMPLIED]
Location and filename of ProtoDeclare source declaration of interest. Multiple locations
are more reliable, and including a Web address lets e-mail attachments work.
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 |
| appinfo |
[appinfo type SFString CDATA #IMPLIED]
Application information to provide simple description usable as a tooltip, similar
to XML Schema appinfo tag. |
| documentation |
[documentation type SFString CDATA #IMPLIED]
Documentation url for further information, similar to XML Schema documentation tag.
|
| 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 |
Extrusion |
[inherits X3DGeometryNode]
Extrusion is a geometry node that sequentially stretches a 2D cross section along
a 3D-spine path in the local coordinate system, creating an outer hull.
Scaling and rotating the crossSection 2D outline at each control point can modify
the outer hull of the Extrusion to produce a wide variety of interesting shapes.
Warning: take care to avoid defining parameter combinations that create self-intersecting,
impossible or inverted geometry.
Hint: Extrusion https://en.wikipedia.org/wiki/Extrusion
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. |
| crossSection |
[crossSection accessType initializeOnly, type MFVec2f CDATA "1 1, 1 -1, -1 -1, -1 1, 1 1"]
The crossSection array defines a silhouette outline of the outer Extrusion surface.
crossSection is an ordered set of 2D points that draw a piecewise-linear curve which
is extruded to form a series of connected vertices.
Hint: the crossSection array can be open or closed (closed means that endpoints are coincident).
Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values,
and 4-tuple orientation values.
Warning: if the order of crossSection point definition does not match clockwise/counterclockwise
setting of ccw field, then self-intersecting, impossible or inverted geometry can
result!
Warning: avoid self-intersecting polygon line segments, otherwise defined geometry is irregular
and rendering results are undefined (especially for end caps). |
| orientation |
[orientation accessType initializeOnly, type MFRotation CDATA "0 0 1 0"]
The orientation array is a list of axis-angle 4-tuple values applied at each spine-aligned
cross-section plane.
Hint: if the orientation array contains a single 4-tuple value, it is applied at all spine-aligned
crossSection planes.
Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values,
and 4-tuple orientation values. |
| scale |
[scale accessType initializeOnly, type MFVec2f CDATA "1 1"] (0,+β)
scale is a list of 2D-scale parameters applied at each spine-aligned cross-section
plane.
Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values,
and 4-tuple orientation values.
Hint: if the scale array contains one value, it is applied at all spine-aligned crossSection
planes.
Warning: zero or negative scale values not allowed. |
| spine |
[spine accessType initializeOnly, type MFVec3f CDATA "0 0 0, 0 1 0"]
The spine array defines a center-line sequence of 3D points that define a piecewise-linear
curve forming a series of connected vertices. The spine is set of points along which
a 2D crossSection is extruded, scaled and oriented.
Hint: the spine array can be open or closed (closed means that endpoints are coincident).
Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values,
and 4-tuple orientation values.
Warning: special care is needed if creating loops or spirals since self-intersecting, impossible
or inverted geometry can result!
Warning: ensure that spine segments have non-zero length and are not coincident with each
other.
Hint: if a spine is closed (or nearly closed) then the inner diameter usually needs to
be greater than the corresponding crossSection width. |
| beginCap |
[beginCap accessType initializeOnly, type SFBool (true|false) "true"]
Whether beginning cap is drawn (similar to Cylinder top cap).
Warning: since this field has accessType initializeOnly, the value cannot be changed after
initial creation. |
| endCap |
[endCap accessType initializeOnly, type SFBool (true|false) "true"]
Whether end cap is drawn (similar to Cylinder bottom cap).
Warning: since this field has accessType initializeOnly, the value cannot be changed after
initial creation. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
The ccw field indicates counterclockwise ordering of vertex-coordinates orientation.
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| convex |
[convex accessType initializeOnly, type SFBool (true|false) "true"]
The convex field is a hint to renderers whether all polygons in a shape are convex
(true), or possibly concave (false). A convex polygon is planar, does not intersect
itself, and has all interior angles < 180 degrees.
Hint: concave is the opposite of convex.
Warning: concave or inverted geometry may be invisible when using default value convex=true,
since some renderers use more-efficient algorithms to perform tessellation that may
inadvertently fail on concave geometry.
Hint: select convex=false (i.e. concave) and solid=false (i.e. two-sided display) for
greatest visibility of geometry.
Hint: convex polygon https://en.wikipedia.org/wiki/Convex_polygon
Hint: tessellation https://en.wikipedia.org/wiki/Tessellation |
| creaseAngle |
[creaseAngle accessType initializeOnly, type SFFloat CDATA "0.0"] [0,+β)
creaseAngle defines angle (in radians) where adjacent polygons are drawn with sharp
edges or smooth shading. If angle between normals of two adjacent polygons is less
than creaseAngle, smooth shading is rendered across the shared line segment.
Hint: creaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all
edges smoothly.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| solid |
[solid accessType initializeOnly, type SFBool (true|false) "true"]
Setting solid true means draw only one side of polygons (backface culling on), setting
solid false means draw both sides of polygons (backface culling off).
Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a
brick).
Warning: default value true can completely hide geometry if viewed from wrong side!
Hint: if in doubt, use solid='false' for maximum visibility.
Hint: accessType relaxed to inputOutput in order to support animation and visualization.
|
| set_crossSection |
[set_crossSection accessType inputOnly, type MFVec2f CDATA #FIXED ""]
The crossSection array defines a silhouette outline of the outer Extrusion surface.
crossSection is an ordered set of 2D points that draw a piecewise-linear curve which
is extruded to form a series of connected vertices.
Warning: if the order of crossSection point definition does not match clockwise/counterclockwise
setting of ccw field, then self-intersecting, impossible or inverted geometry can
result!
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| set_orientation |
[set_orientation accessType inputOnly, type MFRotation CDATA #FIXED ""]
The orientation array is a list of axis-angle 4-tuple values applied at each spine-aligned
cross-section plane.
Hint: if the orientation array contains a single 4-tuple value, it is applied at all spine-aligned
crossSection planes.
Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values,
and 4-tuple orientation values.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| set_scale |
[set_scale accessType inputOnly, type MFVec2f CDATA #FIXED ""] (0,+β)
scale is a list of 2D-scale parameters applied at each spine-aligned cross-section
plane.
Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values,
and 4-tuple orientation values.
Warning: zero or negative scale values not allowed.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| set_spine |
[set_spine accessType inputOnly, type MFVec3f CDATA #FIXED ""]
The spine array defines a center-line sequence of 3D points that define a piecewise-linear
curve forming a series of connected vertices. The spine is set of points along which
a 2D crossSection is extruded, scaled and oriented.
Hint: the spine array can be open or closed (closed means that endpoints are coincident).
Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values,
and 4-tuple orientation values.
Warning: special care is needed if creating loops or spirals since self-intersecting, impossible
or inverted geometry can result!
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| 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 |
field |
[X3D statement]
A field statement defines an interface attribute or node.
Hint: first add a parent Script node, or ProtoDeclare/ProtoInterface statements, or ExternProtoDeclare
statement, before defining a new field.
Hint: in addition to defining a simple-type value attribute, a field statement can alternatively
hold initializing SFNode/MFNode values as contained node(s). |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| name |
[name type NMTOKEN #REQUIRED]
Name of this field declaration.
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 |
| accessType |
[accessType , type NMTOKEN #REQUIRED]
Event-model semantics for field set/get capabilities.
Hint: renamed accessType correspondences for X3D from VRML97 are inputOnly=eventIn, outputOnly=eventOut,
initializeOnly=field, inputOutput=exposedField.
Warning: inputOutput=exposedField not allowed in VRML97 Script nodes, use initializeOnly=field
for backwards compatibility.
Hint: an accessType value is required and must be provided.
Hint: X3D Architecture 4.4.2.2 Field semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#FieldSemantics
Hint: X3D XML Encoding 4.3.7 Prototype and field declaration syntax, https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#PrototypeAndFieldDeclarationSyntax |
| type |
[type NMTOKEN #REQUIRED]
Base type of this field variable.
Hint: a type value is required and must be provided. |
| value |
[value type CDATA #IMPLIED]
Provide default initialization value for this field variable (which may be re-initialized
later by instantiation value of a named ProtoInstance fieldValue).
Hint: SFNode/MFNode fields are initialized using contained node content, instead of this
value attribute.
Warning: do not include a value attribute when providing child node(s) for type SFNode/MFNode.
Hint: value is required for Script and ProtoDeclare unless MF-type array initialization
is empty list, SFString initialization is empty string, or SFNode is being initialized.
Hint: SFNode/MFNode fields are initialized by contained node element(s), if any.
Warning: setting a value is not allowed for ExternProtoDeclare field declarations, since
original ProtoDeclare initializations or local ProtoInstance fieldValue initializations
take precedence.
Warning: not allowed for field variables with accessType inputOnly or outputOnly.
Warning: initialization value is not allowed if this field is part of a Script interface
and has a corresponding IS/connect definition. |
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DNode]
If this field definition has type SFNode or MFNode, then initialization node (or
nodes) of any appropriate type may be provided as children of the field definition.
Warning: do not include a value attribute when providing such child node(s).
Hint: X3D Architecture, Concepts, 4.4.2 Object model, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Objectmodel
Hint: X3D Architecture, Concepts, 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PrototypeSemantics
Hint: X3D Architecture, Scripting component, 29.4.1 Script https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/scripting.html#Script |
| appinfo |
[appinfo type SFString CDATA #IMPLIED]
Application information to provide simple description usable as a tooltip, similar
to XML Schema appinfo tag. |
| documentation |
[documentation type SFString CDATA #IMPLIED]
Documentation url for further information, similar to XML Schema documentation tag.
|
| 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 |
fieldValue |
[X3D statement]
A fieldValue statement re-initializes the default value of a field in a parent ProtoInstance.
Note that a field statement with a matching name must be already defined by the corresponding
ProtoDeclare or ExternProtoDeclare statement.
Hint: first add a parent ProtoInstance node before defining a new fieldValue.
Warning: fieldValue content type must match the content type defined in the corresponding
ProtoDeclare or ExternProtoDeclare field statement.
Hint: in addition to defining a simple-type value attribute, a fieldValue statement can
alternatively hold initializing SFNode/MFNode values as contained node(s). |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| name |
[name type NMTOKEN #REQUIRED]
Name of the ProtoInstance field being re-initialized (corresponding to field name
already defined in ProtoDeclare or ExternProtoDeclare).
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 |
| value |
[value type CDATA #IMPLIED]
Initial value for this field, which overrides default initialization value defined
in original ProtoDeclare field.
Hint: initialize SFNode/MFNode field value using contained content element(s), instead
of a simple attribute value.
Warning: do not include a value attribute when providing child node(s) for type SFNode/MFNode.
|
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DNode]
If this field definition has type SFNode or MFNode, then initialization node (or
nodes) of any appropriate type may be provided as children of the field definition.
Warning: do not include a value attribute when providing such child node(s).
Hint: X3D Architecture, Concepts, 4.4.2 Object model, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Objectmodel
Hint: X3D Architecture, Concepts, 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PrototypeSemantics |
| 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 |
|
FillProperties |
[inherits X3DAppearanceChildNode]
FillProperties indicates whether appearance is filled or hatched for associated
geometry nodes inside the same Shape. Hatches are applied on top of the already rendered
appearance of the node, and are not affected by lighting.
Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related
shapes in a scene.
Warning: requires X3D profile='Full' or else include <component name='Shape' 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 |
| 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. |
| filled |
[filled accessType inputOutput, type SFBool (true|false) "true"]
Whether or not associated geometry is filled. |
| hatched |
[hatched accessType inputOutput, type SFBool (true|false) "true"]
Whether or not associated geometry is hatched. |
| hatchStyle |
[hatchStyle accessType inputOutput, type SFInt32 CDATA "1"]
hatchStyle selects a hatch pattern from ISO/IEC 9973 International Register of Graphical
Items. 1=Horizontal equally spaced parallel lines. 2=Vertical equally spaced parallel
lines. 3=Positive slope equally spaced parallel lines. 4=Negative slope equally spaced
parallel lines. 5=Horizontal/vertical crosshatch. 6=Positive slope/negative slope
crosshatch. 7=(cast iron or malleable iron and general use for all materials). 8=(steel).
9=(bronze, brass, copper, and compositions). 10=(white metal, zinc, lead, babbit,
and alloys). 11=(magnesium, aluminum, and aluminum alloys). 12=(rubber, plastic, and
electrical insulation). 13=(cork, felt, fabric, leather, and fibre). 14=(thermal insulation).
15=(titanium and refi-actory material). 16=(marble, slate, porcelain, glass, etc.).
17=(earth). 18=(sand). 19=(repeating dot).
Hint: detailed descriptions of hatchstyle values are found at the ISO/IEC 9973 International
Register of Graphical Items https://www.iso.org/jtc1/sc24/register at https://isotc.iso.org/livelink/livelink/fetch/-8916524/8916549/8916590/6208440/class_pages/hatchstyle.html |
| hatchColor |
[hatchColor accessType inputOutput, type SFColor CDATA "1 1 1"] [0,1]
Color of the hatch pattern. |
| containerField |
[containerField type NMTOKEN "fillProperties"]
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 |
FloatVertexAttribute |
(X3D version 3.1 or later) [inherits X3DVertexAttributeNode]
FloatVertexAttribute defines a set of per-vertex single-precision floating-point
attributes. |
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. |
| name |
[name accessType initializeOnly, type NMTOKEN #REQUIRED]
Required name for this particular VertexAttribute instance.
Warning: name is not specified if this instance is a USE node.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| value |
[value accessType inputOutput, type MFFloat CDATA ""]
value specifies an arbitrary collection of floating-point values that will be passed
to the shader as per-vertex information.
Hint: the length of the value field shall be a multiple of numComponents. |
| numComponents |
[numComponents accessType initializeOnly, type SFFloat CDATA (1,4) "4"]
numComponents specifies how many consecutive floating-point values should be grouped
together per vertex.
Hint: the length of the value field shall be a multiple of numComponents. |
| containerField |
[containerField type NMTOKEN "attrib"]
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 |
Fog |
[inherits X3DBindableNode, implements X3DFogObject]
Fog simulates atmospheric effects by blending distant objects with fog color.
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. |
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 SFColor CDATA "1 1 1"] [0,1]
Fog color.
Hint: match Background color to make objects fade away.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| fogType |
[fogType accessType inputOutput, type SFString CDATA (LINEAR|EXPONENTIAL) LINEAR]
Specifies algorithm for rate of increasing Fog, either LINEAR or EXPONENTIAL.
Hint: EXPONENTIAL is more natural but also more computationally expensive.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| visibilityRange |
[visibilityRange accessType inputOutput, type SFFloat CDATA "0.0"]
Distance in meters where objects are totally obscured by the fog, using local coordinate
system.
Hint: visibilityRange 0 disables Fog. |
| set_bind |
[set_bind accessType inputOnly, type SFBool #FIXED ""]
Receiving event set_bind=true activates and binds this node at the top of the binding
stack. Receiving event set_bind=false deactivates and unbinds this node from the top
of the binding stack. Thus setting set_bind to true/false will enable/disable the
effect of 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 ""]
Output event true gets sent when node becomes bound and activated, otherwise output
event false gets sent when node becomes unbound and deactivated.
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 reporting timestamp 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 |
|
FogCoordinate |
(X3D version 3.1 or later) [inherits X3DGeometricPropertyNode]
FogCoordinate defines a set of explicit fog depths on a per-vertex basis, overriding
Fog visibilityRange. |
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. |
| depth |
[depth accessType inputOutput, type MFVec3f CDATA #IMPLIED]
depth contains a set of 3D coordinate (triplet) point values. |
| containerField |
[containerField type NMTOKEN "coord"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
FontStyle |
[inherits X3DFontStyleNode]
FontStyle is an X3DFontStyleNode that defines the size, family, justification, and
other styles used by Text nodes.
Hint: full internationalization (i18n) and localization (l10n) features are available
for any written language.
Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related
shapes.
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: first add a Text node as a parent node for FontStyle.
Hint: Wikipedia https://en.wikipedia.org/wiki/Font
Hint: Wikipedia https://en.wikipedia.org/wiki/Typeface |
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. |
| family |
[family accessType inputOutput, type MFString CDATA ( SERIF|SANS|TYPEWRITER ) "SERIF"]
Array of quoted font family names in preference order, browsers use the first supported
family.
Hint: example family array might be "Times" "SERIF"
Warning: font family support often varies.
Hint: values with guaranteed support include "SERIF" "SANS" "TYPEWRITER".
Hint: SERIF and SANS are variable-width fonts (for example, Times Roman and Arial).
Hint: TYPEWRITER is a fixed-width font (for example, Courier).
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks".
Hint: see 15.2.2.2 Font family and style https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Fontfamilyandstyle for details.
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| style |
[style accessType inputOutput, type SFString CDATA ( PLAIN|BOLD|ITALIC|BOLDITALIC ) PLAIN]
Pick one of four values for text style (PLAIN|BOLD|ITALIC|BOLDITALIC).
Warning: overloaded name for CSS style attribute.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values.
Hint: see 15.2.2.2 Font family and style https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Fontfamilyandstyle for details.
Hint: overlapping functionality with CSS style attribute provides a "best of both worlds"
approach. The style attribute provides an inline block of CSS source for element styling,
reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
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
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| justify |
[justify accessType inputOutput, type MFString CDATA ( BEGIN|END|FIRST|MIDDLE ) "BEGIN" or equivalently "BEGIN" "FIRST"]
The justify field determines horizontal and vertical alignment of text layout, relative
to the origin of the object coordinate system.
Hint: preferred value is usually justify=' "MIDDLE" "MIDDLE" ' for centered justification
horizontally and vertically.
Warning: exactly two string values are provided for major and minor axis alignment.
Warning: do not use illegal values such as LEFT RIGHT TOP BOTTOM or CENTER.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks".
Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| size |
[size accessType inputOutput, type SFFloat CDATA "1.0"] (0,+β)
Nominal height (in local coordinate system) of text glyphs, also sets default spacing
between adjacent lines of text.
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| spacing |
[spacing accessType inputOutput, type SFFloat CDATA "1.0"] [0,+β)
Adjustment factor for line spacing between adjacent lines of text.
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| language |
[language accessType inputOutput, type SFString CDATA #IMPLIED]
Language codes consist of a primary code and a (possibly empty) series of subcodes.
[ language-code = primary-code ( "-" subcode )* ] Two-letter primary codes are reserved
for language abbreviations. Two-letter primary codes include en (English), fr (French),
de (German), it (Italian), nl (Dutch), el (Greek), es (Spanish), pt (Portuguese),
ar (Arabic), he (Hebrew), ru (Russian), zh (Chinese), ja (Japanese), hi (Hindi), ur
(Urdu), and sa (Sanskrit). Any two-letter subcode is understood to be a country code.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values.
Hint: see ISO639.2 Codes for the Representation of Names of Languages http://www.loc.gov/standards/iso639-2/php/code_list.php
Hint: see RFC3066 Tags for the Identification of Languages https://tools.ietf.org/html/rfc3066
Hint: see ISO3166 or http://xml.coverpages.org/languageIdentifiers.html
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| horizontal |
[horizontal accessType inputOutput, type SFBool (true|false) "true"]
Whether text direction is horizontal (true) or vertical (false).
Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| leftToRight |
[leftToRight accessType inputOutput, type SFBool (true|false) "true"]
Whether text direction is left-to-right (true) or right-to-left (false).
Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| topToBottom |
[topToBottom accessType inputOutput, type SFBool (true|false) "true"]
Whether text direction is top-to-bottom (true) or bottom-to-top (false).
Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| containerField |
[containerField type NMTOKEN "fontStyle"]
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 |
| |
accessType and type Credits and Translations X3D Resources |
|
ForcePhysicsModel |
(X3D version 3.2 or later) [inherits X3DParticlePhysicsModelNode]
ForcePhysicsModel applies a constant force value to the particles.
Hint: force may act in any given direction vector at any strength. |
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. |
| force |
[force accessType inputOutput, type SFVec3f CDATA "0 -9.8 0"] (-β,+β)
force field indicates strength and direction of the propelling force on the particles
(for example, default is Earth's gravity).
Hint: if particles have zero mass, ForcePhysicsModel node has no effect.
Hint: force is specified in force base units (usually newtons, acceleration of one kilogram
at rate of one meter per second squared).
Hint: https://en.wikipedia.org/wiki/Newton_(unit) and https://en.wikipedia.org/wiki/Kilogram
Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates |
| 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 |
|
Gain |
[inherits X3DSoundProcessingNode]
The Gain node amplifies or deamplifies the input signal.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#gainnode |
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. |
| 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. |
| 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 |
GeneratedCubeMapTexture |
(X3D version 3.1 or later) [inherits X3DEnvironmentTextureNode]
GeneratedCubeMapTexture is a texture node that defines a cubic environment map that
sources its data from internally generated images.
The viewpoint of the generated texture is the location and orientation of the associated
geometry in world space.
Hint: can contain a single TextureProperties node.
Hint: typically a Box is used for applying the GeneratedCubeMapTexture.
Warning: requires X3D profile='Full' or else include <component name='CubeMapTexturing' 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 |
| textureProperties |
[textureProperties accessType initializeOnly, type SFNode singleton, NULL node] [TextureProperties]
Single contained TextureProperties node that can specify additional visual attributes
applied to corresponding texture images. |
| 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). |
| update |
[update accessType inputOutput, type SFString CDATA (NONE|NEXT_FRAME_ONLY|ALWAYS) NONE]
update controls regeneration of the texture.
Warning: An object trying to render itself in the scene graph can cause infinite loops.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| size |
[size accessType initializeOnly, type SFInt32 CDATA "128"] (0,+β)
size indicates the resolution of the generated images in number of pixels per side.
|
| containerField |
[containerField type NMTOKEN "texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
GeoCoordinate |
[inherits X3DCoordinateNode]
GeoCoordinate builds geometry as a set of geographic 3D coordinates.
These are transformed into a geocentric, curved-earth representation.
GeoCoordinate is only used by IndexedFaceSet, IndexedLineSet, LineSet and PointSet.
GeoCoordinate can contain a GeoOrigin node.
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'/>
|
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 |
| geoOrigin |
[geoOrigin accessType initializeOnly, type SFNode singleton, NULL node] [GeoOrigin]
Single contained GeoOrigin node that can specify a local coordinate frame for extended
precision.
Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#high-precisioncoords
Warning: XML validation requires placement as first child node following contained metadata
nodes (if any). |
| 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. |
| geoSystem |
[geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| point |
[point accessType inputOutput, type MFVec3d CDATA #IMPLIED]
point contains a set of actual 3D geographic coordinates, provided in geoSystem
format can split strings if desired: "x1 y1 z1 x2 y2 z2" or "x1 y1 z1", "x2 y2 z2"
|
| containerField |
[containerField type NMTOKEN "coord"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
GeoElevationGrid |
[inherits X3DGeometryNode]
GeoElevationGrid is a geometry node defining a rectangular height field, with default
values for a 1m by 1m square at height 0. Vertices corresponding to GeoElevationGrid
height values define quadrilaterals, which are placed above or below a curved geospatial
surface using geographic coordinates.
Hint: the height array defines (xDimension-1)*(zDimension-1) quadrilaterals.
Warning: generated quadrilaterals can be nonplanar. Tessellation splits quadrilaterals into
triangles along seam starting at initial vertex of the quadrilateral and proceeding
to opposite vertex.
Hint: positive direction for normal of each triangle is on same side of the quadrilateral.
Triangles are defined either counterclockwise or clockwise depending on value of ccw
field.
Hint: GeoElevationGrid can contain GeoOrigin, Color|ColorRGBA, Normal and TextureCoordinate
nodes.
Hint: insert a Shape node before adding geometry or Appearance.
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'/>
Warning: avoid having GeoLocation or GeoTransform as a parent or ancestor node of GeoElevationGrid,
since multiple geospatial transformations then occur with unpredictable results. |
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 |
| geoOrigin |
[geoOrigin accessType initializeOnly, type SFNode singleton, NULL node] [GeoOrigin]
Single contained GeoOrigin node that can specify a local coordinate frame for extended
precision.
Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#high-precisioncoords
Warning: XML validation requires placement as first child node following contained metadata
nodes (if any). |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorPerVertex field. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate
node that can specify coordinates for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| geoGridOrigin |
[geoGridOrigin accessType initializeOnly, type SFVec3d CDATA "0 0 0"]
Geographic coordinate for southwest (lower-left) corner of height dataset. |
| geoSystem |
[geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| xDimension |
[xDimension accessType initializeOnly, type SFInt32 CDATA "0"] (0,+β)
Number of elements in the height array along east-west X direction.
Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
Warning: xDimension < 2 means that GeoElevationGrid contains no quadrilaterals. |
| zDimension |
[zDimension accessType initializeOnly, type SFInt32 CDATA "0"] (0,+β)
Number of elements in the height array along north-south Z direction.
Hint: total lateral z-axis distance equals (zDimension-1) * zSpacing.
Warning: zDimension < 2 means that GeoElevationGrid contains no quadrilaterals. |
| xSpacing |
[xSpacing accessType initializeOnly, type SFDouble CDATA "1.0"] (0,+β)
Distance between grid-array vertices along east-west X direction.
Hint: when geoSystem is GDC, xSpacing is number of degrees of longitude.
Hint: when geoSystem is UTM, xSpacing is number of eastings (meters). |
| zSpacing |
[zSpacing accessType initializeOnly, type SFDouble CDATA "1.0"] (0,+β)
Distance between grid-array vertices along north-south Z direction.
Hint: when geoSystem is GDC, zSpacing is number of degrees of latitude.
Hint: when geoSystem is UTM, zSpacing is number of northings (meters). |
| yScale |
[yScale accessType inputOutput, type SFFloat CDATA "1.0"] [0,+β)
Vertical exaggeration of displayed data produced from the height array. |
| height |
[height accessType initializeOnly, type MFDouble CDATA "0 0"]
Contains xDimension rows * zDimension columns floating-point values for elevation
above ellipsoid.
Hint: height array values are in row-major order from west to east, south to north.
Hint: geoGridOrigin is in southwest (lower-left) corner of height dataset.
Warning: height array values are not retained or available at run time since a browser is
permitted to condense geometry.
Hint: default values do not make sense, this is a specification erratum (Mantis 1447),
be sure to change them.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| set_height |
[set_height accessType inputOnly, type MFDouble CDATA #FIXED ""]
Contains xDimension rows * zDimension columns floating-point values for elevation
above ellipsoid.
Hint: height array values are in row-major order from west to east, south to north.
Hint: geoGridOrigin is in southwest (lower-left) corner of height dataset.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| 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.
Hint: accessType relaxed to inputOutput in order to support animation and visualization.
|
| creaseAngle |
[creaseAngle accessType initializeOnly, type SFDouble CDATA "0"] (0,+β)
creaseAngle defines angle (in radians) for determining whether adjacent polygons
are drawn with sharp edges or smooth shading. If angle between normals of two adjacent
polygons is less than creaseAngle, smooth shading is rendered across the shared line
segment.
Hint: creaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all
edges smoothly.
Warning: note type double, unlike ElevationGrid creaseAngle.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color node color values are applied to each point vertex (true) or per quadrilateral
(false).
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or per
quadrilateral (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. |
| containerField |
[containerField type NMTOKEN "geometry"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
GeoLocation |
[inherits X3DGroupingNode, implements X3DVisibleObject]
GeoLocation positions a regular X3D model onto earth's surface.
GeoLocation can contain children and GeoOrigin nodes.
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'/>
Warning: avoid having GeoLocation or GeoTransform as a parent or ancestor node of each other,
since multiple geospatial transformations then occur with unpredictable results.
Hint: GeoLocation adjusts orientation of children models appropriately: +Y axis is up
direction for that local area (i.e. normal to tangent plane on the geospatial ellipsoid),
-Z axis points towards north pole, and +X axis points east. |
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 |
| geoOrigin |
[geoOrigin accessType initializeOnly, type SFNode singleton, NULL node] [GeoOrigin]
Single contained GeoOrigin node that can specify a local coordinate frame for extended
precision.
Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#high-precisioncoords
Warning: XML validation requires placement as first child node following contained metadata
nodes (if any). |
| 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. |
| geoCoords |
[geoCoords accessType inputOutput, type SFVec3d CDATA "0 0 0"]
Geographic location (specified in current geoSystem coordinates) for children geometry
(specified in relative coordinate system, in meters).
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'/>
|
| geoSystem |
[geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| 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 |
GeoLOD |
[inherits X3DChildNode, implements X3DBoundedObject, X3DVisibleObject]
GeoLOD provides quadtree level-of-detail loading/unloading for multi-resolution
terrains.
GeoLOD can contain children and GeoOrigin nodes.
Hint: children nodes expose the scene graph for the currently loaded set of nodes.
Hint: rootNode specifies the geometry of the root tile.
Warning: do not use rootUrl and rootNode simultaneously, since each specifies the root tile.
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'/>
Warning: nested LOD (and/or GeoLOD) nodes with overlapping range intervals can lead to unexpected
or undefined behavior. |
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 |
| geoOrigin |
[geoOrigin accessType initializeOnly, type SFNode singleton, NULL node] [GeoOrigin]
Single contained GeoOrigin node that can specify a local coordinate frame for extended
precision.
Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#high-precisioncoords
Warning: XML validation requires placement as first child node following contained metadata
nodes (if any). |
| rootNode |
[rootNode accessType initializeOnly, type MFNode #IMPLIED]
Geometry for the root tile.
Warning: either rootNode or rootUrl can specify root tile, but specifying both is an error.
|
| children |
[children accessType outputOnly, type MFNode array, empty list] [X3DChildNode]
The outputOnly children field exposes a portion of the scene graph for the currently
loaded set of nodes. The value returned as an event is an MFNode containing the currently
selected tile. This will either be the node specified by the rootNode field or the
nodes specified by the child1Url, child2Url, child3Url, and child4Url fields. The
GeoLOD node shall generate a new children output event each time the scene graph is
changed (EXAMPLE whenever nodes are loaded or unloaded).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| level_changed |
[level_changed accessType outputOnly, type SFInt32 CDATA #FIXED ""]
Output event that reports when the new children outputOnly event is generated, with
value 0 or 1, where 0 indicates the rootNode field and 1 indicates the nodes specified
by the child1Url, child2Url, child3Url, and child4Url fields.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| geoSystem |
[geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| rootUrl |
[rootUrl accessType initializeOnly, type MFString CDATA #IMPLIED]
url for scene providing geometry for the root tile.
Warning: either rootNode or rootUrl can specify root tile, but specifying both is an error.
|
| child1Url |
[child1Url accessType initializeOnly, type MFString CDATA #IMPLIED]
quadtree geometry loaded when viewer is within range. |
| child2Url |
[child2Url accessType initializeOnly, type MFString CDATA #IMPLIED]
quadtree geometry loaded when viewer is within range. |
| child3Url |
[child3Url accessType initializeOnly, type MFString CDATA #IMPLIED]
quadtree geometry loaded when viewer is within range. |
| child4Url |
[child4Url accessType initializeOnly, type MFString CDATA #IMPLIED]
quadtree geometry loaded when viewer is within range. |
| range |
[range accessType initializeOnly, type SFFloat CDATA #IMPLIED] (0,+β)
Viewer range from geographic-coordinates center triggers quadtree loading/unloading.
Hint: not setting range values indicates that level switching can be optimized automatically
based on performance. |
| center |
[center accessType initializeOnly, type SFVec3d CDATA "0 0 0"]
Viewer range from geographic-coordinates center triggers quadtree loading/unloading.
|
| 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 |
GeoMetadata |
[inherits X3DInfoNode]
GeoMetadata includes a generic subset of metadata about the geographic data.
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'/>
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). |
| 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. |
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Hypertext link to an external, complete metadata description.
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 |
| data |
#IMPLIED]
DEF list of all nodes that implement this data. If no specific geospatial nodes
are identified, then this GeoMetadata node pertains to entire scene. |
| summary |
[summary accessType inputOutput, type MFString CDATA #IMPLIED]
The summary string array contains a set of keyword/value pairs, with each keyword
and its subsequent value contained in separate strings.
Hint: example <GeoMetadata summary=' "title" "San Francisco, California USA" '/>.
Hint: Table 25.5, GeoMetadata keywords and values https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#t-keywordsandvalues
Hint: there should always be an even (or zero) number of strings to match key-value paired
strings. |
| 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 |
GeoOrigin |
[inherits X3DNode]
GeoOrigin specifies local geospatial coordinate system for parent node, enabling
increased geographic precision during scene rendering (by mitigating potential floating-point
roundoff errors). GeoOrigin can be contained by other Geospatial component nodes,
typically via DEF/USE to ensure consistency.
Hint: only one geospatial coordinate system is allowed per scene, thus DEF-ing and later
USE-ing only one GeoOrigin node per scene is recommended.
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'/>
Warning: GeoOrigin is deprecated, discouraged and not legal in X3D v3.3. GeoOrigin can be
ignored in X3D v3.2 and below.
Hint: GeoOrigin is likely to be restored in X3D v4.0 for special use on devices with limited
floating-point resolution.
Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#high-precisioncoords
Warning: XML validation requires placement as first child node following contained metadata
nodes (if any). |
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. |
| geoCoords |
[geoCoords accessType inputOutput, type SFVec3d CDATA "0 0 0"]
Defines absolute geographic location (and implicit local coordinate frame).
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'/>
|
| geoSystem |
[geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| rotateYUp |
[rotateYUp accessType initializeOnly, type SFBool (true|false) "false"]
Whether to rotate coordinates of nodes using this GeoOrigin so that local-up direction
aligns with VRML Y axis rotateYUp false means local up-direction is relative to planet
surface rotateYUp true allows proper operation of NavigationInfo modes FLY, WALK.
|
| containerField |
[containerField type NMTOKEN "geoOrigin"]
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 |
GeoPositionInterpolator |
[inherits X3DInterpolatorNode]
GeoPositionInterpolator animates objects within a geographic coordinate system.
GeoPositionInterpolator can contain a GeoOrigin node.
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 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'/>
|
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 |
| geoOrigin |
[geoOrigin accessType initializeOnly, type SFNode singleton, NULL node] [GeoOrigin]
Single contained GeoOrigin node that can specify a local coordinate frame for extended
precision.
Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#high-precisioncoords
Warning: XML validation requires placement as first child node following contained metadata
nodes (if any). |
| 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. |
| geoSystem |
[geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| 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 MFVec3d 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 SFVec3f 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. |
| geovalue_changed |
[geovalue_changed accessType outputOnly, type SFVec3d CDATA #FIXED ""]
interpolated coordinate in the geographic coordinate system specified by geoSystem
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'/>
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 |
GeoProximitySensor |
(X3D version 3.2 or later) [inherits X3DEnvironmentalSensorNode]
GeoProximitySensor generates events when the viewer enters,
exits and moves within a region of space (defined by a box).
Hint: multiple USEd instances are cumulative, but avoid overlaps.
Hint: can first use GeoTransform to relocate/reorient box.
Hint: surround entire world to start behaviors once scene is loaded.
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='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 |
| geoOrigin |
[geoOrigin accessType initializeOnly, type SFNode singleton, NULL node] [GeoOrigin]
Single contained GeoOrigin node that can specify a local coordinate frame for extended
precision.
Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#high-precisioncoords
Warning: XML validation requires placement as first child node following contained metadata
nodes (if any). |
| 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. |
| geoCenter |
[geoCenter accessType inputOutput, type SFVec3f CDATA "0 0 0"] (deprecated as of v3.3)
Position offset from origin of local coordinate system.
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'/>
|
| geoSystem |
[geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| center |
[center accessType inputOutput, type SFVec3f CDATA "0 0 0"] (starting with v3.3)
Position offset from origin of local coordinate system. |
| size |
[size accessType inputOutput, type SFVec3f CDATA "0 0 0"] [0,+β)
size of Proximity box around center location, oriented within local transformation
frame.
Hint: size 0 0 0 is same as enabled false. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent as viewer enters/exits Proximity box. isActive=true
when viewer enters Proximity box, isActive=false when viewer exits Proximity box.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| geoCoord_changed |
[geoCoord_changed accessType outputOnly, type SFVec3d CDATA #FIXED ""]
Sends geospatial coordinates of viewer's position corresponding to world position
returned by position_changed.
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'/>
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| position_changed |
[position_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
Sends translation event relative to center.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| orientation_changed |
[orientation_changed accessType outputOnly, type SFRotation CDATA #FIXED ""]
Sends rotation event relative to center.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| centerOfRotation_changed |
[centerOfRotation_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
Sends changed centerOfRotation values, likely caused by user interaction.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| enterTime |
[enterTime accessType outputOnly, type SFTime CDATA #FIXED ""]
Time event generated when user's camera enters the box.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| exitTime |
[exitTime accessType outputOnly, type SFTime CDATA #FIXED ""]
Time event generated when user's camera exits the box.
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 |
GeoTouchSensor |
[inherits X3DTouchSensorNode]
GeoTouchSensor returns geographic coordinates for the object being selected.
GeoTouchSensor can contain a GeoOrigin node.
Hint: this sensor detects user interactions affecting peer nodes and their child 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'/>
|
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 |
| geoOrigin |
[geoOrigin accessType initializeOnly, type SFNode singleton, NULL node] [GeoOrigin]
Single contained GeoOrigin node that can specify a local coordinate frame for extended
precision.
Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#high-precisioncoords
Warning: XML validation requires placement as first child node following contained metadata
nodes (if any). |
| 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. |
| geoSystem |
[geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (G D), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: include space characters since a description is not a DEF identifier. Write short
phrases that make descriptions clear and readable.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| isActive |
[isActive accessType inputOutput, type SFBool #FIXED ""]
Select geometry by activating the pointing device (for example, clicking the mouse)
to generate isActive events. Output event isActive=true is sent when geometry is selected
(for example, when primary mouse button is pressed), output event isActive=false is
sent when geometry is deselected (for example, when primary mouse button is released).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| hitGeoCoord_changed |
[hitGeoCoord_changed accessType outputOnly, type SFVec3d CDATA #FIXED ""]
Output event containing 3D point on surface of underlying geometry, given in GeoTouchSensor's
local coordinate system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| hitPoint_changed |
[hitPoint_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
Output event containing 3D point on surface of underlying geometry, given in geometry
coordinates (not geographic coordinates).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| hitNormal_changed |
[hitNormal_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
Output event containing surface normal vector at the hitGeoCoordinate.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| hitTexCoord_changed |
[hitTexCoord_changed accessType outputOnly, type SFVec2f CDATA #FIXED ""]
Output event containing texture coordinates of surface at the hitGeoCoordinate.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isOver |
[isOver accessType outputOnly, type SFBool #FIXED ""]
Is pointing device over sensor's 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. |
| touchTime |
[touchTime accessType outputOnly, type SFTime CDATA #FIXED ""]
Time event generated when touched.
Hint: touchTime event is generated when following three conditions are all met: (a) pointing
device was pointing towards geometry when initially activated (isActive=true), (b)
pointing device is currently pointing towards the geometry (isOver=true), and (c)
pointing device selection is deactivated/deselected by user (isActive=false event
is also generated).
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 |
|
GeoTransform |
[inherits X3DGroupingNode, implements X3DVisibleObject]
GeoTransform is a Grouping node that can contain most nodes. GeoTransform translates,
orients and scales GeoCoordinate geometry within the local world coordinate system.
GeoTransform coordinate system X-Z plane is tangent to ellipsoid of local spatial
reference frame.
Hint: +Y axis is up.
Hint: insert a Shape node before adding geometry or Appearance.
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='2'/>
Warning: avoid having GeoLocation or GeoTransform as a parent or ancestor node of each other,
since multiple geospatial transformations then occur with unpredictable results. |
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 |
| geoOrigin |
[geoOrigin accessType initializeOnly, type SFNode singleton, NULL node] [GeoOrigin]
Single contained GeoOrigin node that can specify a local coordinate frame for extended
precision.
Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#high-precisioncoords
Warning: XML validation requires placement as first child node following contained metadata
nodes (if any). |
| 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. |
| geoCenter |
[geoCenter 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.
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'/>
|
| geoSystem |
[geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| 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. |
| 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 sys tem 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 |
GeoViewpoint |
[inherits X3DViewpointNode]
GeoViewpoint specifies viewpoints using geographic coordinates.
GeoViewpoint can contain a GeoOrigin node.
Since GeoViewpoint must navigate smoothly inside a curved geographic coordinate system,
it includes both Viewpoint and NavigationInfo attributes.
Hint: alternatively can use GeoLocation or GeoTransform as parent of a Viewpoint node
to orient geospatial views.
Hint: include <component name='Geospatial' level='1'/>
Hint: when a GeoViewpoint node is bound, it also overrides the currently bound NavigationInfo
node in the scene and controls user navigation for smoother geospatial interaction.
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.
Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more
than one of these nodes can be bound and 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.
Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch,
instead use ViewpointGroup as parent to constrain location proximity where the viewpoint
is available to user.
Warning: GeoViewpoint navType and headlight fields were removed as part of X3D version 3.3,
authors can instead use a NavigationInfo node for those fields in prior X3D versions
3.0, 3.1 or 3.2. Upgrading such legacy scenes to version 3.3 or greater is preferred
and recommended.
Hint: Regardless of viewpoint jump value at bind time, the relative viewing transformation
between user's view and defined position/orientation is stored for later use when
un-jumping (returning to the viewpoint when subsequent viewpoint is unbound).
Hint: customizable design pattern for dedicated Viewpoint/NavigationInfo pair: <Viewpoint
DEF='SpecialView'/> <NavigationInfo DEF='SpecialNav'/> <ROUTE fromNode='SpecialView'
fromField='isBound' toNode='SpecialNav' toField='set_bind'/>
Warning: avoid having GeoLocation or GeoTransform as a parent or ancestor node of GeoViewpoint,
since multiple geospatial transformations then occur with unpredictable results.
Hint: X3D Scene Authoring Hints, Viewpoints https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Viewpoints |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| geoOrigin |
[geoOrigin accessType initializeOnly, type SFNode singleton, NULL node] [GeoOrigin]
Single contained GeoOrigin node that can specify a local coordinate frame for extended
precision.
Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#high-precisioncoords
Warning: XML validation requires placement as first child node following contained metadata
nodes (if any). |
| 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 |
| navigationInfo |
[navigationInfo accessType inputOutput, type SFNode singleton, NULL node] [NavigationInfo]
The navigationInfo field defines a dedicated NavigationInfo node for this X3DViewpointNode.
The specified NavigationInfo node receives a set_bind TRUE event at the time when
the parent node is bound and receives a set_bind FALSE at the time when the parent
node is unbound.
Hint: allows simple integration of custom navigation associated with each Viewpoint according
to user needs at that location. |
| viewAll |
[viewAll accessType inputOutput, type SFBool (true|false), false]
Viewpoint is automatically adjusted to view all visible geometry. Typically centerOfRotation
is shifted to center of current bounding box and view is zoomed in or out until all
visible objects are viewed.
Hint: no collision detection or proximity sensing occurs when zooming.
Warning: if needed, near and far clipping planes shall be adjusted to allow viewing the entire
scene.
Hint: when the value of the viewAll field is changed from TRUE to FALSE, no change in
the current view occurs. |
| 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. |
| geoSystem |
[geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: include space characters since a description is not a DEF identifier. Write short
phrases that make descriptions clear and readable.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| farDistance |
[farDistance accessType inputOutput, type SFFloat CDATA "-1"] or (0,+β)
farDistance defines maximum clipping plane distance allowed for object display.
Hint: overrides bound NavigationInfo visibilityLimit value, if any.
Hint: default value -1 means no effect on currently defined view frustum boundaries.
Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
Warning: nearDistance must be less than farDistance. |
| nearDistance |
[nearDistance accessType inputOutput, type SFFloat CDATA "-1"] or (0,+β)
nearDistance defines minimum clipping plane distance necessary for object display.
Hint: overrides bound NavigationInfo avatarSize value, if any.
Hint: default value -1 means no effect on currently defined view frustum boundaries.
Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
Warning: nearDistance must be less than farDistance. |
| position |
[position accessType initializeOnly, type SFVec3d CDATA "0 0 100000"]
position relative to local georeferenced coordinate system, in proper format. |
| orientation |
[orientation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Rotation of Viewpoint, relative to default -Z axis direction in local coordinate
system.
Hint: this is orientation _change_ from default direction along the (minus) -Z axis. +Y
axis is the up vector for the local area (the normal to the tangent plane on the ellipsoid),
-Z points towards the north pole, and +X is east 1 0 0 -1.570796 always looks down.
Warning: for VR/AR/MR/XR users wearing a head-mounted display (HMD), animating this field
may induce motion sickness. |
| centerOfRotation |
(X3D version 3.3 or later) [centerOfRotation accessType inputOutput, type SFVec3d CDATA "0 0 0"]
centerOfRotation specifies center point about which to rotate user's eyepoint when
in EXAMINE or LOOKAT mode. |
| fieldOfView |
[fieldOfView accessType inputOutput, type SFFloat CDATA "0.7854" (0,Ο)]
Preferred minimum viewing angle from this viewpoint in radians, providing minimum
height or minimum width (whichever is smaller). Small field of view roughly corresponds
to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.
|
| jump |
[jump accessType inputOutput, type SFBool (true|false) "true"]
Whether to transition instantly by jumping, or else smoothly animate to this Viewpoint.
|
| retainUserOffsets |
[retainUserOffsets accessType inputOutput, type SFBool (true|false) "false"]
Retain (true) or reset to zero (false) any prior user navigation offsets from defined
viewpoint position, orientation. |
| speedFactor |
[speedFactor accessType initializeOnly, type SFFloat CDATA "1"] [0,+β)
speedFactor is a multiplier to modify the original elevation-based speed that is
set automatically by the browser.
Hint: speedFactor is a relative value and not an absolute speed as defined by NavigationInfo.
|
| set_position |
[set_position accessType inputOnly, type SFVec3d CDATA #FIXED ""]
position relative to local georeferenced coordinate system, in proper format.
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_orientation |
[set_orientation accessType inputOnly, type SFRotation CDATA #FIXED ""]
Rotation of Viewpoint, relative to default -Z axis direction in local coordinate
system.
Warning: for VR/AR/MR/XR users wearing a head-mounted display (HMD), animating this field
may induce motion sickness.
Hint: this is orientation _change_ from default direction (0 0 -1) along the -X axis +Y
axis is the up vector for the local area (the normal to the tangent plane on the ellipsoid),
-Z points towards the north pole, and +X is east 1 0 0 -1.570796 always looks down.
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_bind |
[set_bind accessType inputOnly, type SFBool #FIXED ""]
set_bind true makes this node active, set_bind false makes this node inactive.
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 ""]
Output event true gets sent when node becomes bound and activated, otherwise output
event false gets sent when node becomes unbound and deactivated.
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 reporting timestamp 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 |
|
Group |
[inherits X3DGroupingNode, implements X3DVisibleObject]
Group is a Grouping node that can contain most nodes.
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. |
| 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|proxy|rootNode|shape|skin) "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 |
HAnimDisplacer |
[inherits X3DGeometricPropertyNode]
HAnimDisplacer nodes alter the shape of coordinate-based geometry within parent
HAnimJoint or HAnimSegment nodes. Displacer effects are scaled by the corresponding
weight field.
Hint: HAnimDisplacer can be used in three different ways:
(a) identify vertices corresponding to a particular feature in a parent HAnimSegment
node,
(b) represent a particular muscular action for a parent HAnimJoint node by displacing
corresponding HAnimHumanoid skin vertices in various directions (linearly or radially),
or (c) represent a complete configuration of coordinate vertices in parent HAnimSegment
or HAnimJoint nodes.
Example: in the case of a face, there might be a separate HAnimDisplacer node for each facial
expression.
Warning: allowed name suffixes include _feature, _action and _config.
Hint: multiple HAnimDisplacer nodes must appear consecutively inside parent HAnimSegment
for proper content validation in XML encoding.
Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes
must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer
nodes for proper skin animation.
Hint: HAnim Specification https://www.web3d.org/documents/specifications/19774/V2.0
Hint: HAnim Specification part 1, Displacer https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/ObjectInterfaces.html#Displacer
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/HumanoidAnimation.pdf
Warning: requires X3D profile='Full' or else include <component name='HAnim' level='1'/>
Warning: for X3D3 HAnim1, previous spelling of component name was 'H-Anim' (including hyphen).
|
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. |
| 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 NMTOKEN #REQUIRED]
Unique name attribute must be defined so that HAnimDisplacer node can be identified
at run time for animation purposes.
Hint: HAnimDisplacer names are based on feature point names.
Hint: https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/FeaturePoints.html
Warning: allowed name suffixes include _feature, _action and _config.
Warning: name prefix must match ancestor HAnimHumanoid name followed by underscore character,
if more than one humanoid appears within a scene file. For example, 'Nancy_' prepended
before location name.
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
Hint: HAnim2 Names HAnim1 Alias Tables https://www.web3d.org/x3d/content/examples/HumanoidAnimation/HAnim2NameHAnim1AliasTables.txt |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| coordIndex |
[coordIndex accessType inputOutput, type MFInt32 CDATA #IMPLIED] [0,+β)
Defines index values into the parent HAnimSegment or HAnimBody/HAnimHumanoid coordinate
array for the mesh of vertices affected by this HAnimDisplacer. Values start at index
0.
Warning: -1 sentinel values are not allowed. |
| displacements |
[displacements accessType inputOutput, type MFVec3f CDATA #IMPLIED]
displacements are a set of SFVec3f values added to neutral/resting position of each
of the corresponding HAnimSegment vertices (or HAnimJoint/HAnimHumanoid vertices)
referenced by coordIndex field.
Hint: Individual displacement values are scaled by the weight factor, if present.
Hint: since default pose faces along +Z axis, -x values are right side and +x values are
left side within HAnimHumanoid. |
| weight |
[weight accessType inputOutput, type SFFloat CDATA 0.0]
The weigh factor has typical range [0,1] and defines the scale factor applied to
displacement values before adding them to neutral vertex positions.
Hint: apply a non-zero weight factor to see the effect of HAnimDisplacer displacements.
|
| containerField |
[containerField type NMTOKEN "displacers"]
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 |
HAnimHumanoid |
[inherits X3DChildNode, implements X3DBoundedObject, X3DVisibleObject]
The HAnimHumanoid node is used to:
(a) store references to the joints, segments, sites, skeleton, optional skin, and
fixed viewpoints,
(b) serve as a container for the entire humanoid,
(c) provide a convenient way of moving the humanoid through its environment, and
(d) store human-readable metadata such as name, version, author, copyright, age, gender
and other information.
HAnimHumanoid contains a skeleton consisting of HAnimJoint, HAnimSegment and HAnimSite
nodes. HAnimHumanoid can also contain an optional skin consisting of an IndexedFaceSet
mesh with corresponding skinCoord Coordinate|CoordinateDouble vertices and skinNormal
Normal vectors.
Hint: MFNode arrays for the joints, segments, sites, and viewpoints fields provide lists
for all HAnim nodes found in the skeleton hierarchy and thus only contain USE node
references.
Hint: HAnim Specification https://www.web3d.org/documents/specifications/19774/V2.0
Hint: HAnim Specification part 1, Humanoid https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/ObjectInterfaces.html#Humanoid
Hint: HAnim Specification part 2, clause 6.4 Extended definition of Humanoid object https://www.web3d.org/documents/specifications/19774/V2.0/MotionDataAnimation/MotionNodes.html#HumanoidObjectExtension
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/HumanoidAnimation.pdf
Warning: requires X3D profile='Full' or else include <component name='HAnim' level='1'/>
Warning: for X3D3 HAnim1, previous spelling of component name was 'H-Anim' (including hyphen)
|
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 |
| skin |
[skin accessType inputOutput, type MFNode array, empty list] [Group | LOD | Shape | Switch | Transform | IndexedFaceSet | IndexedTriangleFanSet | IndexedLineSet | IndexedQuadSet | IndexedTriangleSet | IndexedTriangleStripSet]
List of one or more indexed mesh definitions (such as IndexedFaceSet) that utilize
skinCoord point and skinNormal normal data.
Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes
must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer
nodes for proper skin animation.
Warning: top-level node must include containerField='skin' for proper validation and operation.
Hint: put skin node first and provide DEF label to simplify USE node usage within the
skeleton hierarchy.
Warning: requires X3D profile='Full' or else include <component name='HAnim' level='2'/>
Warning: for X3D3 HAnim1, previous spelling of component name was 'H-Anim' (including hyphen)
|
| skinCoord |
[skinCoord accessType inputOutput, type SFNode singleton, NULL node] [Coordinate | CoordinateDouble]
Coordinate node utilized by indexed mesh definitions for skin. The skinCoord field
contains a single sequence of points, used by internal HAnimHumanoid mechanisms to
create appropriate surface deformations as well as by the indexed face set definitions
within the skin field that perform the actual rendering of surface geometry.
Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes
must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer
nodes for proper skin animation.
Warning: top-level Coordinate or CoordinateDouble node must include containerField='skinCoord'
for proper validation and operation.
Hint: a single node is used so that coordIndex references are consistent for all references
to these coordinates.
Warning: requires X3D profile='Full' or else include <component name='HAnim' level='2'/>
Warning: for X3D3 HAnim1, previous spelling of component name was 'H-Anim' (including hyphen)
|
| skinNormal |
[skinNormal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single Normal node utilized by indexed mesh definitions for skin. The skinNormal
field contains a single sequence of normal values, used by internal HAnimHumanoid
mechanisms to create appropriate surface deformations as well as by the indexed face
set definitions within the skin field that perform the actual rendering of surface
geometry.
Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes
must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer
nodes for proper skin animation.
Warning: top-level Normal node must include containerField='skinNormal' for proper validation
and operation.
Warning: requires X3D profile='Full' or else include <component name='HAnim' level='2'/>
Warning: for X3D3 HAnim1, spelling of component name is 'H-Anim' (including hyphen). |
| skeleton |
[skeleton accessType inputOutput, type MFNode array, empty list] [HAnimJoint | HAnimSite]
List of top-level HAnimJoint and HAnimSite nodes that create the skeleton model.
The skeleton field contains the humanoid_root Joint object, and thus the entire hierarchy
of HAnimJoint/HAnimSegment nodes making up the articulated skeleton model.
Hint: typically contains HAnimJoint with name='humanoid_root'.
Hint: immediate children in the skeleton field can also include top-level HAnimSite node
declarations, which are landmarks for the overall humanoid figure that are not affected
by HAnimJoint movement.
Warning: top-level HAnimJoint and HAnimSite nodes must include containerField='skeleton'
for proper validation and operation. |
| joints |
[joints accessType inputOutput, type MFNode array, empty list] [HAnimJoint]
The joints field contains a list of USE references for all HAnimJoint node instances
found within the preceding skeleton hierarchy.
Hint: order is irrelevant since names are contained in the original DEF objects.
Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
Warning: the number of contained <HAnimJoint USE='*' containerField='joints'/> nodes at top
level of HAnimHumanoid needs to match the number of corresponding HAnimJoint node
instances found within the preceding skeleton hierarchy.
Warning: top-level HAnimJoint USE nodes must include containerField='joints' for proper validation
and operation. |
| segments |
[segments accessType inputOutput, type MFNode array, empty list] [HAnimSegment]
The segments field contains a list of USE references for all HAnimSegment node instances
found within the preceding skeleton hierarchy.
Hint: order is irrelevant since names are contained in the original DEF objects.
Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
Warning: the number of contained <HAnimSegment USE='*' containerField='segments'/> nodes
at top level of HAnimHumanoid needs to match the number of corresponding HAnimSegment
node instances found within the preceding skeleton hierarchy.
Warning: top-level HAnimSegment USE nodes must include containerField='segments' for proper
validation and operation. |
| sites |
[sites accessType inputOutput, type MFNode array, empty list] [HAnimSite]
sites field contains a list of USE references for all HAnimSite node instances found
within the preceding skeleton hierarchy.
Hint: order is irrelevant since names are contained in the original DEF objects.
Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
Warning: the number of contained <HAnimSite USE='*' containerField='sites, skeleton or viewpoints'/>
nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimSite
node instances found within the preceding skeleton hierarchy.
Warning: top-level HAnimSite USE nodes must include containerField='sites' for proper validation
and operation. |
| viewpoints |
[viewpoints accessType inputOutput, type MFNode array, empty list] [HAnimSite]
List of HAnimSite nodes containing Viewpoint nodes that appear in the skeleton model,
usually as USE node references. The viewpoints field contains zero or more special
HAnimSite nodes that are only affected by HAnimHumanoid transformations (and no HAnimJoint
transformations). Each HAnimSite can contain a Viewpoint as virtual camera in the
HAnimHumanoid reference frame (such as viewing the face or profile of the human figure).
Warning: these are actual node declarations, not USE nodes.
Hint: the viewpoint field has different functionality than the joints, segments and sites
fields.
Hint: the viewpoints field connects internal Site nodes that in turn hold relative Viewpoint
nodes, such as <HAnimSite USE='ObserveFaceSite_view' containerField='viewpoints'/>
which has corresponding counterpart nodes <HAnimSite DEF='ObserveFaceSite_view' name='ObserveFaceSite_view'
containerField='children'> <Viewpoint description='look at me!'/> </HAnimSite>.
Warning: top-level HAnimSite nodes (in turn containing Viewpoint nodes) must include containerField='viewpoints'
for proper validation and operation. |
| 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 NMTOKEN #REQUIRED]
Unique name attribute must be defined so that each HAnimHumanoid node in a scene
can be identified at run time for animation purposes.
Hint: this same name is a required name prefix for all other HAnim nodes within the HAnimHumanoid,
if more than one humanoid appears within a scene file.
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
Hint: HAnim2 Names HAnim1 Alias Tables https://www.web3d.org/x3d/content/examples/HumanoidAnimation/HAnim2NameHAnim1AliasTables.txt |
| version |
[version accessType inputOutput, type SFString CDATA (2.0) "2.0"]
HAnimHumanoid version, where allowed value is 2.0 for final ISO 19774 version 2019.
Hint: default HAnimHumanoid version is 1.0 for X3D version 3, and HAnimHumanoid required
version is 2.0 for X3D version 4.
Warning: no other values are allowed for strict validation.
Warning: prior developmental versions of HAnim nodes, such as version 1 of standardized ISO
19774 version 2006, might not validate correctly due to small changes in the contained-node
content model, so conversion of such models is recommended. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| info |
[info accessType inputOutput, type MFString CDATA #IMPLIED]
Contains metadata keyword=value pairs, where approved keyword terms are humanoidVersion
authorName authorEmail copyright creationDate usageRestrictions age gender height
and weight.
Hint: height and weight are in base units (typically meters), hanimVersion is for author
use and separate from HAnimHumanoid version field.
Hint: alternate metadata keywords are also allowed. |
| translation |
[translation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position of children relative to local coordinate system.
Hint: since default pose faces along +Z axis, -x values are right side and +x values are
left side within HAnimHumanoid. |
| rotation |
[rotation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Orientation of children relative to local coordinate system.
Warning: default pose is typically empty (or an identity rotation) to avoid distorted body
animations. |
| 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.
Warning: HAnimHumanoid scale values must be positive. |
| scaleOrientation |
[scaleOrientation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Preliminary rotation of coordinate system before scaling (to allow scaling around
arbitrary orientations). |
| center |
[center accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Translation offset from origin of local coordinate system. |
| 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 |
| loa |
[loa accessType inputOutput, type SFInt32 CDATA -1] [-1,4]
Level Of Articulation 0..4 indicates complexity and detail of joints for given humanoid
skeletal hierarchy.
Hint: loa value of -1 indicates that no LOA conformance is provided.
Hint: Humanoid Animation (HAnim) Specification, Part 1 Architecture, 4.8.4 Levels of articulation,
https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#LevelsOfArticulation |
| motions |
[motions accessType inputOutput, type MFNode array, empty list] [HAnimMotion]
Contains any HAnimMotion nodes that can animate the HAnimHumanoid. |
| motionsEnabled |
[motionsEnabled accessType inputOutput, type MFBool CDATA empty list]
Array of boolean values corresponding to HAnimMotion nodes indicating which can
animate the HAnimHumanoid. |
| skeletalConfiguration |
[skeletalConfiguration accessType inputOutput, type SFString CDATA 'BASIC']
Models sharing a common skeletal configuration can share animations and binding
poses.
Hint: a value of 'BASIC' conforms to restrictive skeletal model in X3D Humanoid Animation
(HAnim) Specification, Part 1 Architecture, 4.8 Modelling of humanoids, https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#ModellingOfHumanoids |
| jointBindingPositions |
[jointBindingPositions accessType inputOutput, type MFVec3f CDATA #IMPLIED]
Specifies an array of position values for each HAnimJoint node in the joints field,
in order, corresponding to each binding pose.
Hint: if only one value is provided, it is provided to each Joint equivalently.
Warning: not used when skeletalConfiguration='BASIC'. |
| jointBindingRotations |
[jointBindingRotations accessType inputOutput, type MFRotation CDATA #IMPLIED]
Specifies an array of rotation values for each HAnimJoint node in the joints field,
in order, corresponding to each binding pose.
Hint: if only one value is provided, it is provided to each Joint equivalently.
Warning: not used when skeletalConfiguration='BASIC'. |
| jointBindingScales |
[jointBindingScales accessType inputOutput, type MFVec3f CDATA #IMPLIED]
Specifies an array of scale values for each HAnimJoint node in the joints field,
in order, corresponding to each binding pose.
Hint: if only one value is provided, it is provided to each Joint equivalently.
Warning: not used when skeletalConfiguration='BASIC'. |
| skinBindingCoords |
[skinBindingCoords accessType inputOutput, type SFNode singleton, NULL node] [Coordinate | CoordinateDouble]
Array of Coordinate nodes to handle non-default source pose so that both skin and
skeleton can be in same binding pose.
Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes
must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer
nodes for proper skin animation.
Warning: top-level Coordinate or CoordinateDouble nodes must include containerField='skinBindingCoords'
for proper validation and operation.
Hint: a single node is used so that coordIndex references are consistent for all references
to these coordinates.
Warning: requires X3D profile='Full' or else include <component name='HAnim' level='2'/>
Warning: for X3D3 HAnim1, spelling of component name is 'H-Anim' (including hyphen).
Warning: not used when skeletalConfiguration='BASIC'. |
| skinBindingNormals |
[skinBindingNormals accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Array of Normal nodes to handle non-default source pose so that both skin and skeleton
can be in same binding pose.
Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes
must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer
nodes for proper skin animation.
Warning: top-level Normal nodes must include containerField='skinBindingNormals' for proper
validation and operation.
Warning: requires X3D profile='Full' or else include <component name='HAnim' level='2'/>
Warning: for X3D3 HAnim1, spelling of component name is 'H-Anim' (including hyphen).
Warning: not used when skeletalConfiguration='BASIC'. |
| 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 |
HAnimJoint |
[inherits X3DGroupingNode, implements X3DVisibleObject]
HAnimJoint node can represent each joint in a body. The child HAnimSegment node
provides a visual representation of the skeleton segment.
Hint: HAnimJoint may only get inserted as one (or more) root nodes of HAnimHumanoid skeleton
field, as a child of another HAnimJoint node, or as a USE node in the HAnimHumanoid
joints field.
Warning: HAnimJoint can only contain certain nodes: HAnimJoint and HAnimSegment (with containerField='children')
and also HAnimDisplacer nodes (with containerField='displacers').
Hint: visualization shapes for HAnimJoint nodes can be placed in child HAnimSegment or
HAnimSite nodes.
Warning: an HAnimJoint may not be a child of an HAnimSegment.
Hint: HAnim Specification https://www.web3d.org/documents/specifications/19774/V2.0
Hint: HAnim Specification part 1, Joint https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/ObjectInterfaces.html#Joint
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/HumanoidAnimation.pdf
Warning: requires X3D profile='Full' or else include <component name='HAnim' level='1'/>
Warning: for X3D3 HAnim1, spelling of component name is 'H-Anim' (including hyphen).
Warning: for X3D3 HAnim1, spelling of component name is 'H-Anim' (including hyphen).
Warning: the number of contained <HAnimJoint USE='*' containerField='joints'/> nodes at top
level of HAnimHumanoid needs to match the number of corresponding HAnimJoint node
instances found within the preceding skeleton hierarchy.
Hint: HAnim2 default values for Joint and Site (feature point) nodes https://www.web3d.org/x3d/content/examples/HumanoidAnimation/HAnim2DefaultValuesJointsFeaturePoints.txt |
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] [HAnimJoint | HAnimSegment]
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.
Warning: HAnimJoint can only contain HAnimJoint|HAnimSegment nodes (each having default containerField='children').
Hint: place any geometry for this HAnimJoint in the child HAnimSegment, wrapped within
a Transform having the same translation value as the current HAnimJoint center value.
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 |
| displacers |
[displacers accessType inputOutput, type MFNode array, empty list] [HAnimDisplacer]
the displacers field stores HAnimDisplacer objects for a particular HAnimJoint object.
Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes
must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer
nodes for proper skin animation. |
| 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 NMTOKEN #REQUIRED]
Unique name attribute must be defined so that HAnimJoint node can be identified
at run time for animation purposes.
Warning: name prefix must match ancestor HAnimHumanoid name followed by underscore character,
if more than one humanoid appears within a scene file. For example, 'Nancy_' prepended
before location name.
Warning: name field is not included if this instance is a USE node, in order to avoid potential
mismatches.
Examples: humanoid_root sacroiliac l_hip l_knee l_ankle etc. as listed in HAnim Specification.
Hint: HAnim Specification part 1, Humanoid Joint-Segment Hierarchy https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#Hierarchy
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
Hint: HAnim2 Names HAnim1 Alias Tables https://www.web3d.org/x3d/content/examples/HumanoidAnimation/HAnim2NameHAnim1AliasTables.txt
Warning: note precise spelling of special HAnimJoint name='humanoid_root' according to https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#TheBody
Hint: candidate names found in the HAnim Specification are humanoid_root, sacroiliac,
l_hip, l_knee, l_talocrural, l_talocalcaneonavicular, l_cuneonavicular_1, l_tarsometatarsal_1,
l_metatarsophalangeal_1, l_tarsal_interphalangeal_1, l_cuneonavicular_2, l_tarsometatarsal_2,
l_metatarsophalangeal_2, l_tarsal_proximal_interphalangeal_2, l_tarsal_distal_interphalangeal_2,
l_cuneonavicular_3, l_tarsometatarsal_3, l_metatarsophalangeal_3, l_tarsal_proximal_interphalangeal_3,
l_tarsal_distal_interphalangeal_3, l_calcaneocuboid, l_transversetarsal, l_tarsometatarsal_4,
l_metatarsophalangeal_4, l_tarsal_proximal_interphalangeal_4, l_tarsal_distal_interphalangeal_4,
l_tarsometatarsal_5, l_metatarsophalangeal_5, l_tarsal_proximal_interphalangeal_5,
l_tarsal_distal_interphalangeal_5, r_hip, r_knee, r_talocrural, r_talocalcaneonavicular,
r_cuneonavicular_1, r_tarsometatarsal_1, r_metatarsophalangeal_1, r_tarsal_interphalangeal_1,
r_cuneonavicular_2, r_tarsometatarsal_2, r_metatarsophalangeal_2, r_tarsal_proximal_interphalangeal_2,
r_tarsal_distal_interphalangeal_2, r_cuneonavicular_3, r_tarsometatarsal_3, r_metatarsophalangeal_3,
r_tarsal_proximal_interphalangeal_3, r_tarsal_distal_interphalangeal_3, r_calcaneocuboid,
r_transversetarsal, r_tarsometatarsal_4, r_metatarsophalangeal_4, r_tarsal_proximal_interphalangeal_4,
r_tarsal_distal_interphalangeal_4, r_tarsometatarsal_5, r_metatarsophalangeal_5, r_tarsal_proximal_interphalangeal_5,
r_tarsal_distal_interphalangeal_5, vl5, vl4, vl3, vl2, vl1, vt12, vt11, vt10, vt9,
vt8, vt7, vt6, vt5, vt4, vt3, vt2, vt1, vc7, vc6, vc5, vc4, vc3, vc2, vc1, skullbase,
l_eyelid_joint, r_eyelid_joint, l_eyeball_joint, r_eyeball_joint, l_eyebrow_joint,
r_eyebrow_joint, temporomandibular, l_sternoclavicular, l_acromioclavicular, l_shoulder,
l_elbow, l_radiocarpal, l_midcarpal_1, l_carpometacarpal_1, l_metacarpophalangeal_1,
l_carpal_interphalangeal_1, l_midcarpal_2, l_carpometacarpal_2, l_metacarpophalangeal_2,
l_carpal_proximal_interphalangeal_2, l_carpal_distal_interphalangeal_2, l_midcarpal_3,
l_carpometacarpal_3, l_metacarpophalangeal_3, l_carpal_proximal_interphalangeal_3,
l_carpal_distal_interphalangeal_3, l_midcarpal_4_5, l_carpometacarpal_4, l_metacarpophalangeal_4,
l_carpal_proximal_interphalangeal_4, l_carpal_distal_interphalangeal_4, l_carpometacarpal_5,
l_metacarpophalangeal_5, l_carpal_proximal_interphalangeal_5, l_carpal_distal_interphalangeal_5,
r_sternoclavicular, r_acromioclavicular, r_shoulder, r_elbow, r_radiocarpal, r_midcarpal_1,
r_carpometacarpal_1, r_metacarpophalangeal_1, r_carpal_interphalangeal_1, r_midcarpal_2,
r_carpometacarpal_2, r_metacarpophalangeal_2, r_carpal_proximal_interphalangeal_2,
r_carpal_distal_interphalangeal_2, r_midcarpal_3, r_carpometacarpal_3, r_metacarpophalangeal_3,
r_carpal_proximal_interphalangeal_3, r_carpal_distal_interphalangeal_3, r_midcarpal_4_5,
r_carpometacarpal_4, r_metacarpophalangeal_4, r_carpal_proximal_interphalangeal_4,
r_carpal_distal_interphalangeal_4, r_carpometacarpal_5, r_metacarpophalangeal_5, r_carpal_proximal_interphalangeal_5,
r_carpal_distal_interphalangeal_5 |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| center |
[center accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Translation offset from origin of local coordinate system.
Hint: usually HAnimJoint position is controlled by the center field, not the translation
field. |
| translation |
[translation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position of children relative to local coordinate system.
Warning: usually HAnimJoint position is controlled by the center field, not the translation
field.
Hint: since default pose faces along +Z axis, -x values are right side and +x values are
left side within HAnimHumanoid. |
| rotation |
[rotation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Orientation of children relative to local coordinate system.
Warning: default pose is typically empty (or an identity rotation) to avoid distorted body
animations. |
| 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.
|
| scaleOrientation |
[scaleOrientation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Preliminary rotation of coordinate system before scaling (to allow scaling around
arbitrary orientations). |
| ulimit |
[ulimit accessType inputOutput, type MFFloat CDATA "0 0 0"]
Upper limit for maximum joint rotation in radians.
Hint: always contains 3 values, one for each local axis.
Warning: field shall contain three values or else be an empty array. Behavior is undefined
when array length is 1, 2, or greater than 3.
Hint: an empty array is equivalent to 0 0 0. |
| llimit |
[llimit accessType inputOutput, type MFFloat CDATA "0 0 0"]
Lower limit for minimum joint rotation in radians.
Hint: always contains 3 values, one for each local axis.
Warning: field shall contain three values or else be an empty array. Behavior is undefined
when array length is 1, 2, or greater than 3.
Hint: an empty array is equivalent to 0 0 0. |
| limitOrientation |
[limitOrientation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Orientation of upper/lower rotation limits, relative to HAnimJoint center. |
| skinCoordIndex |
[skinCoordIndex accessType inputOutput, type MFInt32 CDATA #IMPLIED] [0,+β)
Coordinate index values referencing which vertices are influenced by the HAnimJoint.
Warning: -1 sentinel values are not allowed.
Hint: corresponding skinCoord Coordinate and skinNormal Normal nodes are directly contained
within the ancestor HAnimHumanoid node for this HAnimJoint.
Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes
must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer
nodes for proper skin animation. |
| skinCoordWeight |
[skinCoordWeight accessType inputOutput, type MFFloat CDATA #IMPLIED]
Weight deformation values for the corresponding values in the skinCoordIndex field.
Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes
must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer
nodes for proper skin animation. |
| stiffness |
[stiffness accessType inputOutput, type MFFloat CDATA "0 0 0"] [0,1]
A scale factor of (1 - stiffness) is applied around the corresponding axis (X, Y,
or Z for entries 0, 1 and 2 of the stiffness field). Thus a stiffness value of zero
means that no rotation scaling occurs, while a stiffness value of one means that no
rotation occurs regardless of any provided rotation.
Warning: field shall contain three values or else be an empty array. Behavior is undefined
when array length is 1, 2, or greater than 3.
Hint: an empty array is equivalent to 0 0 0.
Hint: used by inverse kinematics (IK) systems. |
| 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|skeleton|joints) "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 |
HAnimMotion |
[inherits X3DChildNode]
An HAnimMotion node supports discrete frame-by-frame playback for HAnim motion data
animation. Design characteristics include integration with HAnim figure data and HAnimJoint
nodes, animation control, and playback of raw motion data.
Hint: HAnim Specification https://www.web3d.org/documents/specifications/19774/V2.0
Hint: HAnim Specification, clause 6.2 Introduction to Motion objectshttps://www.web3d.org/documents/specifications/19774/V2.0/MotionDataAnimation/MotionNodes.html#IntroductionToMotionNodes
Hint: HAnim Specification part 2, clause 6.6 Example Usage of Motion object https://www.web3d.org/documents/specifications/19774/V2.0/MotionDataAnimation/MotionNodes.html#MotionObjectExample |
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. |
| name |
[name accessType inputOutput, type NMTOKEN #REQUIRED]
Unique name attribute must be defined so that HAnimMotion node can be identified
at run time for animation purposes. |
| channels |
[channels accessType inputOutput, type SFString CDATA #IMPLIED]
list of number of channels for transformation, followed by transformation type of
each channel of data. Each value is space or comma separated.
Hint: channels are enabled by default, unless otherwise indicated by channelsEnabled field.
|
| channelsEnabled |
[channelsEnabled accessType inputOutput, type MFBool CDATA #IMPLIED]
boolean values for each channel indicating whether enabled. |
| joints |
[joints accessType inputOutput, type SFString CDATA #IMPLIED]
joints field lists names of joints that raw motion data is to be applied to. The
number and order of the names in the joints field shall match the number and order
of the channels field information, and the number and order of the sets of values
in the values field for each frame of the animation.
Hint: values are space or comma separated.
Hint: The joint name IGNORED shall be used for channel of motion data that is not used
for any joint. |
| loa |
[loa accessType inputOutput, type SFInt32 CDATA -1] [-1,4]
Level Of Articulation 0..4 indicates complexity and detail of joints for given humanoid
skeletal hierarchy.
Hint: loa value of -1 indicates that no LOA conformance is provided.
Hint: Humanoid Animation (HAnim) Specification, Part 1 Architecture, 4.8.4 Levels of articulation,
https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#LevelsOfArticulation |
| cycleTime |
[cycleTime accessType outputOnly, type SFTime CDATA #FIXED ""]
cycleTime sends a time event at initial starting time and at beginning of each new
cycle.
Hint: this event is useful for synchronization with other time-based animation objects.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| frameCount |
[frameCount accessType outputOnly, type SFInt32 CDATA] [0,+β)
frameCount is computed at run time and indicates the total number of frames present
in the animation, equaling the number of sets of channel data rows present in the
values array. |
| frameDuration |
[frameDuration accessType inputOutput, type SFTime CDATA "0.1"] (0,+β)
frameDuration specifies the duration of each frame in seconds. |
| frameIncrement |
[frameIncrement accessType inputOutput, type SFInt32 CDATA "1"] [-β,+β)
frameIncrement field controls whether playback direction is forwards or backwards,
and also whether frames are skipped (for example, subsampled replay). For a single
animation step, the next frameIndex value equals (frameIndex + frameIncrement) modulo
frameCount.
Hint: note that setting frameIncrement to 0 prevents automatic advancement of frameIndex
and pauses animation of HAnimMotion node. |
| frameIndex |
[frameIndex accessType inputOutput, type SFInt32 CDATA "0"] [0,+β)
frameIndex indicates index of current frame. Note that frameIndex can be modified
whether the Motion node is enabled or not, and becomes effective when the next animation
cycle occurs. Thus the frameIndex value indicates the frame currently (or next) being
processed.
Hint: frameIndex starts at 0 and is no greater than (frameCount - 1). Values less than
0 are reset as 0. Values greater or equal to frameCount are stored as (frameCount
- 1). Thus the value of frameIndex shall be greater than or equal to zero, and less
than frameCount. |
| loop |
[loop accessType inputOutput, type SFBool (true|false) "false"]
Repeat indefinitely when loop=true, repeat only once when loop=false. |
| skeletalConfiguration |
(X3D version 4.1 draft) [skeletalConfiguration accessType inputOutput, type SFString CDATA 'BASIC']
Models sharing a common skeletal configuration can share animations and binding
poses.
Hint: a value of 'BASIC' conforms to restrictive skeletal model in X3D Humanoid Animation
(HAnim) Specification, Part 1 Architecture, 4.8 Modelling of humanoids, https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#ModellingOfHumanoids |
| startFrame |
[startFrame accessType inputOutput, type SFInt32 CDATA "0"] [0,+β)
startFrame indicates initial index of animated frame. Note that startFrame can precede,
equal or follow endFrame.
Hint: startFrame starts at 0 and is no greater than (frameCount - 1). |
| endFrame |
[endFrame accessType inputOutput, type SFInt32 CDATA "0"] [0,+β)
endFrame indicates final index of animated frame. Note that endFrame can precede,
equal or follow endFrame. The default endFrame value is reset to (frameCount - 1)
whenever frameCount is changed.
Hint: endFrame starts at 0 and is no greater than (frameCount - 1). |
| values |
[values accessType inputOutput, type MFFloat CDATA #IMPLIED]
values field contains all transformation values, ordered first by frame, then by
joint, and then by transformation Sets of floats in the values array matching the
order listed in joints and channels fields. |
| next |
[next accessType inputOnly, type SFBool (true|false) ""]
Send next output value in values array, using/updating various frame values as appropriate.
Hint: this input event will "wrap around" boundary of frame array, i.e. continue from
endFrame next to startFrame 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 values array, using/updating various frame values
as appropriate.
Hint: this input event will "wrap around" boundary of frame array, i.e. continue from
startFrame next to endFrame 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. |
| elapsedTime |
[elapsedTime accessType outputOnly, type SFTime CDATA #FIXED ""] [0,+β)
elapsedTime is computed elapsed time since the Motion object was activated and running,
counting all traversed frames (as if frameIndex equaled 1) and multiplied by frameDuration,
cumulative in seconds.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events.
Hint: elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time.
|
| containerField |
[containerField type NMTOKEN (motions|children)"motions"]
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 |
HAnimSegment |
[inherits X3DGroupingNode, implements X3DVisibleObject]
HAnimSegment node contains Shape geometry for each body segment, providing a visual
representation of the skeleton segment. Parent/child translation and rotation relationships
are defined in ancestor/descendant HAnimSegment nodes.
HAnimSegment contains Coordinate|CoordinateDouble with containerField='coord', HAnimDisplacer
with containerField='displacers' and Shape or grouping nodes with containerField='children'.
Hint: HAnimSegment displays geometry between parent HAnimJoint and sibling HAnimJoint
nodes.
Hint: HAnim Specification https://www.web3d.org/documents/specifications/19774/V2.0
Hint: HAnim Specification part 1, Segment https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/ObjectInterfaces.html#Segment
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/HumanoidAnimation.pdf
Warning: requires X3D profile='Full' or else include <component name='HAnim' level='1'/>
Warning: for X3D3 HAnim1, previous spelling of component name was 'H-Anim' (including hyphen).
Warning: the number of contained <HAnimSegment USE='*' containerField='segments'/> nodes
at top level of HAnimHumanoid needs to match the number of corresponding HAnimJoint
node instances found within the preceding skeleton hierarchy. |
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: place any geometry for parent HAnimJoint within a child Transform having the same
translation value as the parent HAnimJoint center value.
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 |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [Coordinate | CoordinateDouble]
the coord field is used for HAnimSegment objects that have deformable meshes and
shall contain coordinates referenced from the IndexedFaceSet for the paarent HAnimSegment
object. The coordinates are given the same name as the HAnim Segment object, but with
"_coords" appended to the name (for example, "skull_coords").
Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes
must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer
nodes for proper skin animation. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| displacers |
[displacers accessType inputOutput, type MFNode array, empty list] [HAnimDisplacer]
the displacers field stores HAnimDisplacer objects for a particular HAnimSegment
object.
Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes
must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer
nodes for proper skin animation. |
| 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 NMTOKEN #REQUIRED]
Unique name attribute must be defined so that HAnimSegment node can be identified
at run time for animation purposes.
Warning: name prefix must match ancestor HAnimHumanoid name followed by underscore character,
if more than one humanoid appears within a scene file. For example, 'Nancy_' prepended
before location name.
Warning: name field is not included if this instance is a USE node, in order to avoid potential
mismatches.
Examples: sacrum pelvis l_thigh l_calf etc. as listed in HAnim Specification.
Hint: for abitrary humanoids, HAnimSegment name can describe geometry between parent HAnimJoint
and sibling HAnimJoint nodes (for example LeftHip_to_LeftKnee).
Hint: HAnim Specification part 1, Humanoid Joint-Segment Hierarchy https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#Hierarchy
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
Hint: HAnim2 Names HAnim1 Alias Tables https://www.web3d.org/x3d/content/examples/HumanoidAnimation/HAnim2NameHAnim1AliasTables.txt
Hint: candidate names found in the HAnim Specification are sacrum, pelvis, l_thigh, l_calf,
l_talus, l_navicular, l_cuneiform_1, l_metatarsal_1, l_tarsal_proximal_phalanx_1,
l_tarsal_distal_phalanx_1, l_cuneiform_2, l_metatarsal_2, l_tarsal_proximal_phalanx_2,
l_tarsal_middle_phalanx_2, l_tarsal_distal_phalanx_2, l_cuneiform_3, l_metatarsal_3,
l_tarsal_proximal_phalanx_3, l_tarsal_middle_phalanx_3, l_tarsal_distal_phalanx_3,
l_calcaneus, l_cuboid, l_metatarsal_4, l_tarsal_proximal_phalanx_4, l_tarsal_middle_phalanx_4,
l_tarsal_distal_phalanx_4, l_metatarsal_5, l_tarsal_proximal_phalanx_5, l_tarsal_middle_phalanx_5,
l_tarsal_distal_phalanx_5, r_thigh, r_calf, r_talus, r_navicular, r_cuneiform_1, r_metatarsal_1,
r_tarsal_proximal_phalanx_1, r_tarsal_distal_phalanx_1, r_cuneiform_2, r_metatarsal_2,
r_tarsal_proximal_phalanx_2, r_tarsal_middle_phalanx_2, r_tarsal_distal_phalanx_2,
r_cuneiform_3, r_metatarsal_3, r_tarsal_proximal_phalanx_3, r_tarsal_middle_phalanx_3,
r_tarsal_distal_phalanx_3, r_calcaneus, r_cuboid, r_metatarsal_4, r_tarsal_proximal_phalanx_4,
r_tarsal_middle_phalanx_4, r_tarsal_distal_phalanx_4, r_metatarsal_5, r_tarsal_proximal_phalanx_5,
r_tarsal_middle_phalanx_5, r_tarsal_distal_phalanx_5, l5, l4, l3, l2, l1, t12, t11,
t10, t9, t8, t7, t6, t5, t4, t3, t2, t1, c7, c6, c5, c4, c3, c2, c1, skull, l_eyelid,
r_eyelid, l_eyeball, r_eyeball, l_eyebrow, r_eyebrow, jaw, l_clavicle, l_scapula,
l_upperarm, l_forearm, l_carpal, l_trapezium, l_metacarpal_1, l_carpal_proximal_phalanx_1,
l_carpal_distal_phalanx_1, l_trapezoid, l_metacarpal_2, l_carpal_proximal_phalanx_2,
l_carpal_middle_phalanx_2, l_carpal_distal_phalanx_2, l_capitate, l_metacarpal_3,
l_carpal_proximal_phalanx_3, l_carpal_middle_phalanx_3, l_carpal_distal_phalanx_3,
l_hamate, l_metacarpal_4, l_carpal_proximal_phalanx_4, l_carpal_middle_phalanx_4,
l_carpal_distal_phalanx_4, l_metacarpal_5, l_carpal_proximal_phalanx_5, l_carpal_middle_phalanx_5,
l_carpal_distal_phalanx_5, r_clavicle, r_scapula, r_upperarm, r_forearm, r_carpal,
r_trapezium, r_metacarpal_1, r_carpal_proximal_phalanx_1, r_carpal_distal_phalanx_1,
r_trapezoid, r_metacarpal_2, r_carpal_proximal_phalanx_2, r_carpal_middle_phalanx_2,
r_carpal_distal_phalanx_2, r_capitate, r_metacarpal_3, r_carpal_proximal_phalanx_3,
r_carpal_middle_phalanx_3, r_carpal_distal_phalanx_3, r_hamate, r_metacarpal_4, r_carpal_proximal_phalanx_4,
r_carpal_middle_phalanx_4, r_carpal_distal_phalanx_4, r_metacarpal_5, r_carpal_proximal_phalanx_5,
r_carpal_middle_phalanx_5, r_carpal_distal_phalanx_5 |
| mass |
[mass accessType inputOutput, type SFFloat CDATA "0"]
Total mass of the segment, 0 if not available, defined in mass base units (default
is kilograms).
Hint: https://en.wikipedia.org/wiki/Kilogram
Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates |
| centerOfMass |
[centerOfMass accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Location within segment of center of mass. |
| momentsOfInertia |
[momentsOfInertia accessType inputOutput, type MFFloat CDATA "0 0 0 0 0 0 0 0 0"]
3x3 moments of inertia matrix. default: 0 0 0 0 0 0 0 0 0. |
| 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|segments) "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 |
|
HAnimSite |
[inherits X3DGroupingNode, implements X3DVisibleObject]
An HAnimSite node serves three purposes:
(a) define an "end effector" location which can be used by an inverse kinematics system,
(b) define an attachment point for accessories such as jewelry and clothing, and
(c) define a location for a Viewpoint virtual camera in the reference frame of an
HAnimSegment
(such as a view "through the eyes" of the humanoid for use in multi-user worlds).
Hint: HAnimSite nodes are stored as children of an HAnimSegment node.
Warning: ensure that visible HAnimSite locations are not inadvertently obscured by skin animation.
Hint: HAnim Specification https://www.web3d.org/documents/specifications/19774/V2.0
Hint: HAnim Specification part 1, Site https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/ObjectInterfaces.html#Site
Hint: HAnim Specification part 1, Annex B, Feature points for the human body https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/FeaturePoints.html
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/HumanoidAnimation.pdf
Warning: requires X3D profile='Full' or else include <component name='HAnim' level='1'/>
Warning: for X3D3 HAnim1, previous spelling of component name was 'H-Anim' (including hyphen).
Warning: the number of contained <HAnimSite USE='*' containerField='sites, skeleton or viewpoints'/>
nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimSite
node instances found within the preceding skeleton hierarchy.
Hint: HAnim2 default values for Joint and Site (feature point) nodes https://www.web3d.org/x3d/content/examples/HumanoidAnimation/HAnim2DefaultValuesJointsFeaturePoints.txt |
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 NMTOKEN #REQUIRED]
Unique name attribute must be defined so that HAnimSite node can be identified at
run time for animation purposes.
Hint: HAnimSite names are typically based on feature point names, though other author-defined
names are also allowed.
Hint: https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/FeaturePoints.html
Warning: name prefix must match ancestor HAnimHumanoid name followed by underscore character,
if more than one humanoid appears within a scene file. For example, 'Nancy_' prepended
before location name.
Warning: name field is not included if this instance is a USE node, in order to avoid potential
mismatches.
Hint: HAnimSite nodes used as end effectors have '_tip' suffix appended to the name.
Hint: HAnimSite nodes containing a Viewpoint location have '_view' suffix appended to
the name.
Hint: HAnimSite nodes serving other purposes have '_pt' suffix appended to the name.
Warning: HAnimSite name must end in '_tip' or '_view' or '_pt' suffix.
Hint: additional example name bases (such as cervicale l_infraorbitale supramenton etc.)
are listed in HAnim Specification.
Hint: HAnim Specification part 1, LOA-3 default Site object translations https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/BodyDimensionsAndLOAs.html#LOA3DefaultSiteTranslations
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
Hint: HAnim2 Names HAnim1 Alias Tables https://www.web3d.org/x3d/content/examples/HumanoidAnimation/HAnim2NameHAnim1AliasTables.txt
Hint: candidate names found in the HAnim Specification are skull_vertex, glabella, sellion,
l_infraorbitale, l_tragion, l_gonion, r_infraorbitale, r_tragion, r_gonion, supramenton,
cervicale, adams_apple, suprasternale, substernale, l_clavicle, l_acromion, l_axilla_proximal,
l_axilla_distal, l_axilla_posterior_folds, r_clavicle, r_acromion, r_axilla_proximal,
r_axilla_distal, r_axilla_posterior_folds, spine_1_middle_back, spine_2_lower_back,
waist_preferred_anterior, waist_preferred_posterior, l_rib10, l_thelion, r_rib10,
r_thelion, l_asis, l_iliocristale, l_psis, r_asis, r_iliocristale, r_psis, crotch,
l_femoral_lateral_epicondyle, l_femoral_medial_epicondyle, l_suprapatella, l_trochanterion,
r_femoral_lateral_epicondyle, r_femoral_medial_epicondyle, r_suprapatella, r_trochanterion,
l_tibiale, l_medial_malleolus, l_lateral_malleolus, l_sphyrion, r_tibiale, r_medial_malleolus,
r_lateral_malleolus, r_sphyrion, l_metatarsal_phalanx_1, l_metatarsal_phalanx_5, l_dactylion,
l_calcaneus_posterior, r_metatarsal_phalanx_1, r_metatarsal_phalanx_5, r_dactylion,
r_calcaneus_posterior, l_humeral_lateral_epicondyle, l_humeral_medial_epicondyle,
l_olecranon, r_humeral_lateral_epicondyle, r_humeral_medial_epicondyle, r_olecranon,
l_radiale, l_ulnar_styloid, l_radial_styloid, r_radiale, r_ulnar_styloid, r_radial_styloid,
l_metacarpal_phalanx_2, l_metacarpal_phalanx_3, l_metacarpal_phalanx_5, r_metacarpal_phalanx_2,
r_metacarpal_phalanx_3, r_metacarpal_phalanx_5, nuchale, l_neck_base, r_neck_base,
navel, l_ectocanthus, r_ectocanthus, menton, mesosternale, opisthocranion, l_knee_crease,
r_knee_crease, rear_center_midsagittal_plane, buttocks_standing_wall_contact_point,
l_chest_midsagittal_plane, r_chest_midsagittal_plane, l_bideltoid, r_bideltoid, l_carpal_distal_phalanx_1,
l_carpal_distal_phalanx_2, l_carpal_distal_phalanx_3, l_carpal_distal_phalanx_4, l_carpal_distal_phalanx_5,
r_carpal_distal_phalanx_1, r_carpal_distal_phalanx_2, r_carpal_distal_phalanx_3, r_carpal_distal_phalanx_4,
r_carpal_distal_phalanx_5, l_tarsal_distal_phalanx_1, l_tarsal_distal_phalanx_2, l_tarsal_distal_phalanx_3,
l_tarsal_distal_phalanx_4, l_tarsal_distal_phalanx_5, r_tarsal_distal_phalanx_1, r_tarsal_distal_phalanx_2,
r_tarsal_distal_phalanx_3, r_tarsal_distal_phalanx_4, r_tarsal_distal_phalanx_5 |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| center |
[center accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Default location of this HAnimSite, i.e. offset of center from origin of local coordinate
system.
Hint: center field indicates default origin relative to overall humanoid body and is rarely
modified. For HAnimSite animation, ROUTE position-change events to translation field
instead. |
| translation |
[translation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position of children relative to local coordinate system.
Hint: since default pose faces along +Z axis, -x values are right side and +x values are
left side within HAnimHumanoid.
Hint: center field indicates default origin relative to overall humanoid body and is rarely
modified. For HAnimSite animation, ROUTE position-change events to translation field
instead. |
| rotation |
[rotation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Orientation of children relative to local coordinate system. |
| 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.
|
| scaleOrientation |
[scaleOrientation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Preliminary rotation of coordinate system before scaling (to allow scaling around
arbitrary orientations). |
| 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|sites|skeleton|viewpoints) "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 |
head |
[X3D statement]
head can contain component, unit, and author-defined meta (metadata) elements.
Hint: design for this element is patterned after the <head> tag in HTML: https://www.w3.org/TR/html5/document-metadata.html#the-head-element
Warning: head is optional first child of X3D statement, and must precede the Scene statement.
Warning: in order to pass XML validation, these contained optional statements must appear
in order: first component statements, then unit statements, then meta statements.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| component |
[X3D statement component]
Add component statements to indicate necessary scene functionality above the given
profile for this X3D model. |
| unit |
[X3D statement unit]
Add unit statements to define data-conversion factors for typed values defined within
a scene. |
| meta |
[X3D statement meta]
Add meta statements to provide metadata information about this X3D model. |
| 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 |
ImageCubeMapTexture |
(X3D version 3.1 or later) [inherits X3DEnvironmentTextureNode, implements X3DUrlObject]
ImageCubeMapTexture is a texture node that defines a cubic environment map source
as a single file format that contains multiple images, one for each side.
Hint: can contain a single TextureProperties node.
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 |
| textureProperties |
[textureProperties accessType initializeOnly, type SFNode singleton, NULL node] [TextureProperties]
Single contained TextureProperties node that can specify additional visual attributes
applied to corresponding texture images. |
| 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). |
| 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. |
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Location and filename of image. Multiple locations are more reliable, and including
a Web address lets e-mail attachments work.
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 |
| containerField |
[containerField type NMTOKEN (texture|watchList) "texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
ImageTexture |
[inherits X3DTexture2DNode, implements X3DUrlObject]
ImageTexture maps a 2D-image file onto a geometric shape.
Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s,
t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.
Hint: can contain a single TextureProperties node.
Hint: insert Shape and Appearance nodes before adding texture.
Warning: bright Material emissiveColor values can wash out some textures.
Hint: authors can provide multiple image formats for the same image, with each source
address listed separately in the url field.
Hint: player support is required for .png and .jpg formats, support is suggested for .gif
format. Other image formats are optionally supported.
Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
Warning: see ComposedCubeMapTexture and TextureBackground for special containerField values.
Hint: if a texture is opaque, omitting values in the alpha channel can help avoid rendering
artifacts related to transparency and reduce file size by 25%.
Hint: Texture coordinates are reapplied (or else recomputed if textureTransform field
initially NULL) whenever the corresponding vertex-based geometry changes.
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/lighting.html#Lightingmodel
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 |
| textureProperties |
[textureProperties accessType initializeOnly, type SFNode singleton, NULL node] [TextureProperties]
Single contained TextureProperties node that can specify additional visual attributes
applied to corresponding texture images. |
| 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). |
| 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. |
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Location and filename of image. Multiple locations are more reliable, and including
a Web address lets e-mail attachments work.
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 |
| repeatS |
[repeatS accessType initializeOnly, type SFBool (true|false) "true"]
Whether to repeat texture along S axis horizontally from left to right. |
| repeatT |
[repeatT accessType initializeOnly, type SFBool (true|false) "true"]
Whether to repeat texture along T axis vertically from top to bottom. |
| containerField |
[containerField type NMTOKEN (texture|watchList|back|bottom|front|left|right|top|backTexture|bottomTexture|frontTexture|leftTexture|rightTexture|topTexture|baseTexture|emissiveTexture|metallicRoughnessTexture|normalTexture|occlusionTexture)
"texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
ImageTexture3D |
(X3D version 3.1 or later) [inherits X3DTexture3DNode, implements X3DUrlObject]
ImageTexture3D defines a 3D image-based texture map by specifying a single image
file that contains complete 3D data.
Warning: there are no required file formats, but at least one of the following formats is
recommended for volume support in an X3D browser.
Hint: Microsoft DirectDraw Surface (DDS) https://docs.microsoft.com/en-us/windows/win32/direct3ddds/dx-graphics-dds
Hint: Digital Imaging and Communications in Medicine (DICOM) https://www.dicomstandard.org
Nevertheless DDS, DICOM, NRRD and/or .vol formats are recommended.
Hint: Nearly Raw Raster Data (NRRD) http://teem.sourceforge.net/nrrd
Hint: Volume data format (VOL) http://paulbourke.net/dataformats/volumetric
Hint: X3D Scene Authoring Hints, Volume Tools and Volumes Visualization https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Volumes
Hint: can contain a single TextureProperties node.
Hint: insert Shape and Appearance nodes before adding texture.
Hint: X3D Architecture 33.2.2 3D texturing concepts https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texture3D.html#3DTextureconcepts
Hint: when parent node is LoadSensor, apply containerField='children' (X3Dv4) or containerField='watchList'
(X3Dv3). https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
Warning: requires X3D profile='Full' or else include <component name='Texturing3D' 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 |
| textureProperties |
[textureProperties accessType initializeOnly, type SFNode singleton, NULL node] [TextureProperties]
Single contained TextureProperties node that can specify additional visual attributes
applied to corresponding texture images. |
| 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). |
| 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. |
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Location and filename of image. Multiple locations are more reliable, and including
a Web address lets e-mail attachments work.
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 |
| repeatR |
[repeatR accessType initializeOnly, type SFBool (true|false) "false"]
Whether to repeat texture along R axis from front to back. |
| repeatS |
[repeatS accessType initializeOnly, type SFBool (true|false) "false"]
Whether to repeat texture along S axis horizontally from left to right. |
| repeatT |
[repeatT accessType initializeOnly, type SFBool (true|false) "false"]
Whether to repeat texture along T axis vertically from top to bottom. |
| containerField |
[containerField type NMTOKEN (texture|watchList) "texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
IMPORT |
[X3D statement]
IMPORT enables ROUTE access to an external node that has a corresponding EXPORT
statement within an Inline scene. Such connections allow event values to be passed
via ROUTE statements between a parent model and a child Inline model.
Hint: it is good practice to place IMPORT statements next to corresponding Inline scenes
for readability.
Hint: see EXPORT statement for corresponding functionality within the related Inline model.
Warning: corresponding parent-scene IMPORT and child Inline-scene EXPORT statements are necessary
in order to ROUTE values between a parent model and a child Inline model.
Warning: node types must match.
Hint: Inline EXPORT example:https://www.web3d.org/x3d/content/examples/Basic/X3dSpecifications/InlineExportIndex.html
Hint: Inline IMPORT example:https://www.web3d.org/x3d/content/examples/Basic/X3dSpecifications/InlineImportIndex.html
Hint: X3D Architecture 4.4.6 Import/Export semantics https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#ImportExportsemantics
Hint: X3D XML Encoding, 4.3.12 IMPORT/EXPORT statement syntax https://web3d.org/specifications/X3Dv4Draft/ISO-IEC19776-1v4.0-WD1/Part01/concepts.html#IMPORT_EXPORTStatementSyntax |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| inlineDEF |
[inlineDEF type IDREF #REQUIRED]
inlineDEF is the DEF name of Inline node in the same scene as this IMPORT statement.
Warning: the inlineDEF Inline scene must similarly include a corresponding EXPORT statement.
|
| importedDEF |
[importedDEF type NMTOKEN #REQUIRED]
importedDEF is DEF name of the node of interest that is exported by the remote inlineDEF
model.
Hint: required. |
| AS |
[AS type ID #IMPLIED]
map importedDEF name AS a new name in current scene.
Hint: optional, default export is importedDEF node name. |
| 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 |
IndexedFaceSet |
[inherits X3DComposedGeometryNode]
IndexedFaceSet defines polygons using index lists corresponding to vertex coordinates.
IndexedFaceSet is a geometry node containing a Coordinate|CoordinateDouble node, and
can also contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
Hint: Polygon https://en.wikipedia.org/wiki/Polygon
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content.
Warning: rendering characteristics are undefined if polygons are not planar.
Warning: avoid self-intersecting polygon line segments, otherwise defined geometry is irregular
and rendering results are undefined. |
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 |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. Normal vectors are rapidly computed at run
time by GPUs and thus are rarely needed in model files if no special effects are expected.
|
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate
node that can specify coordinates for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| coordIndex |
[coordIndex accessType initializeOnly, type MFInt32 CDATA #IMPLIED] [-1,+β)
coordIndex indices provide the order in which coordinates are applied to construct
each polygon face. Order starts at index 0, commas are optional between sets.
Hint: sentinel value -1 is used to separate indices for each successive polygon.
Warning: coordIndex is required in order to connect contained coordinate point values. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| convex |
[convex accessType initializeOnly, type SFBool (true|false) "true"]
The convex field is a hint to renderers whether all polygons in a shape are convex
(true), or possibly concave (false). A convex polygon is planar, does not intersect
itself, and has all interior angles < 180 degrees.
Hint: concave is the opposite of convex. Interchange profile
Hint: only convex=true IndexedFaceSets have guaranteed support.
Warning: concave or inverted geometry may be invisible when using default value convex=true,
since some renderers use more-efficient algorithms to perform tessellation that may
inadvertently fail on concave geometry.
Hint: select convex=false (i.e. concave) and solid=false (i.e. two-sided display) for
greatest visibility of geometry.
Hint: convex polygon https://en.wikipedia.org/wiki/Convex_polygon
Hint: tessellation https://en.wikipedia.org/wiki/Tessellation |
| 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.
Hint: accessType relaxed to inputOutput in order to support animation and visualization.
|
| creaseAngle |
[creaseAngle accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
creaseAngle defines angle (in radians) for determining whether adjacent polygons
are drawn with sharp edges or smooth shading. If angle between normals of two adjacent
polygons is less than creaseAngle, smooth shading is rendered across the shared line
segment. Interchange profile
Hint: only 0 and Ο radians supported.
Hint: creaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all
edges smoothly.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color|ColorRGBA values are applied to each point vertex (true) or to each
polygon face (false).
Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding
Appearance and material/texture values.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| colorIndex |
[colorIndex accessType initializeOnly, type MFInt32 CDATA #IMPLIED] [-1,+β)
colorIndex values define the order in which Color|ColorRGBA values are applied to
polygons (or vertices), interspersed by -1 if colorlPerVertex=true.
Hint: if colorIndex array is not provided, then Color|ColorRGBA values are indexed according
to the coordIndex field. Omitting duplicative colorIndex fields can reduce file size.
Hint: If colorPerVertex='false' then one index is provided for each polygon defined by
the coordIndex array. No sentinel -1 values are included.
Hint: If colorPerVertex='true' then a matching set of indices is provided, each separated
by sentinel -1, that exactly corresponds to individual values in the coordIndex array
polygon definitions.
Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding
Appearance and material/texture values. |
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or to
each polygon face (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. |
| normalIndex |
[normalIndex accessType initializeOnly, type MFInt32 CDATA #IMPLIED] [-1,+β)
normalIndex values define the order in which normal vectors are applied to polygons
(or vertices), interspersed by -1 if normalPerVertex=true.
Hint: if normalIndex array is not provided, then Normal values are indexed according to
the coordIndex field. Omitting duplicative normalIndex fields can reduce file size.
Hint: If normalPerVertex='false' then one index is provided for each polygon defined by
the coordIndex array. No sentinel -1 values are included.
Hint: If normalPerVertex='true' then a matching set of indices is provided, each separated
by sentinel -1, that exactly corresponds to individual values in the coordIndex array
polygon definitions.
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. Interchange
profile
Hint: this field may be ignored, applying the default value regardless. |
| texCoordIndex |
[texCoordIndex accessType initializeOnly, type MFInt32 CDATA #IMPLIED] [-1,+β)
List of texture-coordinate indices mapping attached texture to corresponding coordinates.
Hint: if texCoordIndex array is not provided, then TextureCoordinate values are indexed
according to the coordIndex field. Omitting duplicative texCoordIndex fields can reduce
file size.
Hint: use an authoring tool! |
| set_colorIndex |
[set_colorIndex accessType inputOnly, type MFInt32 CDATA #FIXED ""]
colorIndex values define the order in which Color|ColorRGBA values are applied to
polygons (or vertices), interspersed by -1 if colorlPerVertex=true.
Hint: if colorIndex array is not provided, then Color|ColorRGBA values are indexed according
to the coordIndex field. Omitting duplicative colorIndex fields can reduce file size.
Hint: If colorPerVertex='false' then one index is provided for each polygon defined by
the coordIndex array. No sentinel -1 values are included.
Hint: If colorPerVertex='true' then a matching set of indices is provided, each separated
by sentinel -1, that exactly corresponds to individual values in the coordIndex array
polygon definitions.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| set_coordIndex |
[set_coordIndex accessType inputOnly, type MFInt32 CDATA #FIXED ""]
coordIndex indices provide the order in which coordinates are applied to construct
each polygon face. Order starts at index 0, commas are optional between sets.
Hint: sentinel value -1 is used to separate indices for each successive polygon.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| set_normalIndex |
[set_normalIndex accessType inputOnly, type MFInt32 CDATA #FIXED ""] [-1,+β)
normalIndex values define the order in which normal vectors are applied to polygons
(or vertices), interspersed by -1 if normalPerVertex=true.
Hint: this field may be ignored, applying the default value regardless.
Hint: if normalIndex array is not provided, then Normal values are indexed according to
the coordIndex field. Omitting duplicative normalIndex fields can reduce file size.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| set_texCoordIndex |
[set_texCoordIndex accessType inputOnly, type MFInt32 CDATA #FIXED ""] [-1,+β)
List of texture-coordinate indices mapping attached texture to corresponding coordinates.
Hint: use an authoring tool!
Hint: if texCoordIndex array is not provided, then TextureCoordinate values are indexed
according to the coordIndex field. Omitting duplicative texCoordIndex fields can reduce
file size.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| 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 |
IndexedLineSet |
[inherits X3DGeometryNode]
IndexedLineSet defines polyline segments using index lists corresponding to vertex
coordinates. IndexedLineSet is a geometry node that can contain a Coordinate|CoordinateDouble
node and optionally a Color|ColorRGBA node.
Hint: Polygonal chain https://en.wikipedia.org/wiki/Polygonal_chain
Hint: either values in a contained Color node, or else Material emissiveColor in corresponding
Appearance node, are used for rendering lines and points.
Warning: lines are not lit, are not texture-mapped, and do not participate in collision detection.
Warning: use a different color (or 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: if rendering Coordinate points originally defined for an IndexedFaceSet,
index values may need to repeat each initial vertex to close each polygon outline.
Hint: step-wise variation or linear interpolation of color values can be used as a good
scientific visualization technique to map arbitrary function values to a color map.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content.
Hint: consider including Fog (with Fog color matching Background color) to provide further
depth cueing for IndexedLineSet (ILS). |
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 |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| 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. |
| coordIndex |
[coordIndex accessType initializeOnly, type MFInt32 CDATA #IMPLIED] [-1,+β)
coordIndex indices provide the order in which coordinates are applied to construct
each polygon face. Order starts at index 0, commas are optional between sets, use
-1 to separate indices for each polyline.
Hint: if rendering Coordinate points originally defined for an IndexedFaceSet, index values
may need to repeat initial each initial vertex to close the polygons.
Hint: sentinel value -1 is used to separate indices for each successive polyline.
Warning: coordIndex is required in order to connect contained coordinate point values. |
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color node color values are applied to each point vertex (true) or per polyline
(false).
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| colorIndex |
[colorIndex accessType initializeOnly, type MFInt32 CDATA #IMPLIED] [-1,+β)
colorIndex values define the order in which Color|ColorRGBA values are applied to
polygons (or vertices), interspersed by -1 if colorlPerVertex=true.
Hint: if colorIndex array is not provided, then Color|ColorRGBA values are indexed according
to the coordIndex field. Omitting duplicative colorIndex fields can reduce file size.
Hint: If colorPerVertex='false' then one index is provided for each polygon defined by
the coordIndex array. No sentinel -1 values are included.
Hint: If colorPerVertex='true' then a matching set of indices is provided, each separated
by sentinel -1, that exactly corresponds to individual values in the coordIndex array
polygon definitions.
Hint: if rendering Coordinate points originally defined for an IndexedFaceSet, index values
may need to repeat initial each initial vertex to close the polygons.
Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding
Appearance and material/texture values. |
| set_colorIndex |
[set_colorIndex accessType inputOnly, type MFInt32 CDATA #FIXED ""]
colorIndex values define the order in which Color|ColorRGBA values are applied to
polygons (or vertices), interspersed by -1 if colorlPerVertex=true.
Hint: if colorIndex array is not provided, then Color|ColorRGBA values are indexed according
to the coordIndex field.
Hint: If colorPerVertex='false' then one index is provided for each polygon defined by
the coordIndex array. No sentinel -1 values are included.
Hint: If colorPerVertex='true' then a matching set of indices is provided, each separated
by sentinel -1, that exactly corresponds to individual values in the coordIndex array
polygon definitions. Omitting duplicative colorIndex fields can reduce file size.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| set_coordIndex |
[set_coordIndex accessType inputOnly, type MFInt32 CDATA #FIXED ""]
coordIndex indices provide the order in which coordinates are applied to construct
each polyline. Order starts at index 0, commas are optional between sets.
Hint: sentinel value -1 is used to separate indices for each successive polyline.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| 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 |
|
IndexedQuadSet |
(X3D version 3.1 or later) [inherits X3DComposedGeometryNode]
IndexedQuadSet is a geometry node that defines planar quadrilaterals. IndexedQuadSet
contains a Coordinate|CoordinateDouble node, and can also contain Color|ColorRGBA,
Normal and TextureCoordinate nodes.
Hint: Quadrilateral https://en.wikipedia.org/wiki/Quadrilateral
Hint: Quadrilateral https://en.wikipedia.org/wiki/Quadrilateral
Hint: color, normal and texCoord values are applied in the same order as coord values.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content.
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='1'/>
Warning: rendering characteristics are undefined if polygons are not planar.
Warning: avoid self-intersecting polygon line segments, otherwise defined geometry is irregular
and rendering results are undefined. |
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 |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate
node that can specify coordinates for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| index |
[index accessType initializeOnly, type MFInt32 CDATA #IMPLIED] [0,+β)
index values provide order in which coordinates are applied. Order starts at index
0, commas are optional between sets. Four unique indices are defined for each quadrilateral.
Warning: -1 sentinel values are not allowed. |
| set_index |
[set_index accessType inputOnly, type MFInt32 CDATA #IMPLIED] [0,+β)
index values provide order in which coordinates are applied. Order starts at index
0, commas are optional between sets. Four unique indices are defined for each quadrilateral.
Warning: -1 sentinel values are not allowed.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color|ColorRGBA values are applied to each point vertex (true) or to each
polygon face (false).
Warning: the provided value of IndexedQuadSet colorPerVertex field is ignored and always
treated as true.
Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding
Appearance and material/texture values.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or to
each polygon face (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. |
| 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.
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 |
IndexedTriangleFanSet |
[inherits X3DComposedGeometryNode]
IndexedTriangleFanSet is a geometry node containing a Coordinate|CoordinateDouble
node, and can also contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
Hint: color, normal and texCoord values are applied in the same order as coord values.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate
node that can specify coordinates for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| index |
[index accessType initializeOnly, type MFInt32 CDATA #IMPLIED] [-1,+β)
index list specifies triangles by connecting Coordinate vertices, each individual
fan separated by -1 sentinel value.
Hint: first indexed coordinate in each sequence is fan center. |
| set_index |
[set_index accessType inputOnly, type MFInt32 CDATA #IMPLIED] [-1,+β)
index list specifies triangles by connecting Coordinate vertices, each individual
fan separated by -1 sentinel value.
Hint: first indexed coordinate in each sequence is fan center.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color|ColorRGBA values are applied to each point vertex (true) or to each
polygon face (false).
Warning: the provided value of IndexedTriangleFanSet colorPerVertex field is ignored and
always treated as true.
Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding
Appearance and material/texture values.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or to
each polygon face (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. |
| 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.
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 |
|
IndexedTriangleSet |
[inherits X3DComposedGeometryNode]
IndexedTriangleSet is a geometry node containing a Coordinate|CoordinateDouble node,
and can also contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
Hint: color, normal and texCoord values are applied in the same order as coord values.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate
node that can specify coordinates for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| index |
[index accessType initializeOnly, type MFInt32 CDATA #IMPLIED] [0,+β)
index list specifies triangles by connecting Coordinate vertices.
Warning: -1 sentinel values are not allowed. |
| set_index |
[set_index accessType inputOnly, type MFInt32 CDATA #IMPLIED] [0,+β)
index list specifies triangles by connecting Coordinate vertices.
Warning: -1 sentinel values are not allowed.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color|ColorRGBA values are applied to each point vertex (true) or to each
polygon face (false).
Warning: the provided value of IndexedTriangleSet colorPerVertex field is ignored and always
treated as true.
Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding
Appearance and material/texture values.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or to
each polygon face (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. |
| 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.
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 |
IndexedTriangleStripSet |
[inherits X3DComposedGeometryNode]
IndexedTriangleStripSet is a geometry node containing a Coordinate|CoordinateDouble
node, and can also contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
Hint: color, normal and texCoord values are applied in the same order as coord values.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate
node that can specify coordinates for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| index |
[index accessType initializeOnly, type MFInt32 CDATA #IMPLIED] [-1,+β)
index list specifies triangles by connecting Coordinate vertices for each individual
strip, separated by -1 sentinel values. |
| set_index |
[set_index accessType inputOnly, type MFInt32 CDATA #IMPLIED] [-1,+β)
index list specifies triangles by connecting Coordinate vertices for each individual
strip, separated by -1 sentinel values.
Hint: this field is not accessType inputOutput since X3D browsers might use different
underlying geometric representations for high-performance rendering, and so output
events are not appropriate. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color|ColorRGBA values are applied to each point vertex (true) or to each
polygon face (false).
Warning: the provided value of IndexedTriangleStripSet colorPerVertex field is ignored and
always treated as true.
Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding
Appearance and material/texture values.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or to
each polygon face (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. |
| 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.
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 |
Inline |
[inherits X3DGroupingNode, implements X3DBoundedObject, X3DUrlObject, X3DVisibleObject]
Inline can load another X3D or VRML model into the current scene via url. Inline
is an X3DBoundedObject node that has bounding-box dimensions.
Hint: X3D version='4.0' support includes .gltf and .glb https://www.khronos.org/gltf https://en.wikipedia.org/wiki/glTF
Hint: you cannot ROUTE values directly into an Inline node, use IMPORT/EXPORT declarations
instead.
Hint: Inline EXPORT example:https://www.web3d.org/x3d/content/examples/Basic/X3dSpecifications/InlineExportIndex.html
Hint: Inline IMPORT example:https://www.web3d.org/x3d/content/examples/Basic/X3dSpecifications/InlineImportIndex.html
Hint: X3D Scene Authoring Hints, Inlines and Prototypes https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#InlinesPrototypes
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). |
| global |
[global accessType inputOutput, type SFBool (true|false) "false"]
The global field controls potential external scoping effects of lights found within
an Inline scene. Global lights illuminate all objects within their volume of lighting
influence. Scoped lights only illuminate objects within the same transformation hierarchy.
Hint: X3D Architecture, 17.2.1.2 Scoping of lights https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/lighting.html#ScopingOfLights |
| 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. |
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Address of X3D world to load Inline with current scene, retrieved either from local
system or an online address. Browser support for X3D model support can include allowed
file formats for XML .x3d, ClassicVRML .x3dv, X3D Binary .x3db, X3D JSON .json, and
Virtual Reality Modeling Language (VRML97) .wrl.
Hint: support includes .gltf and .glb https://www.khronos.org/gltf https://en.wikipedia.org/wiki/glTF
Warning: glTF support requires X3D version='4.0' and profile='Full' or else <component name='Networking'
level='4'/> <component name='Shape' level='4'/> <component name='Lighting' level='4'/>
https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/networking.html#t-supportLevels
Hint: future work planned for PLY format https://en.wikipedia.org/wiki/PLY_(file_format)
Hint: future work planned for STL format https://en.wikipedia.org/wiki/STL_(file_format)
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 |
| 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 |
IntegerSequencer |
[inherits X3DSequencerNode]
IntegerSequencer generates periodic discrete integer values. Authors can ROUTE value_changed
output events to other SFInt32 attributes (for example, useful when animating whichChoice
in a Switch node).
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 MFInt32 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 SFInt32 CDATA #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. |
| 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. |
| 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. |
| 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 |
|
IntegerTrigger |
[inherits X3DTriggerNode]
IntegerTrigger converts set_boolean true input events to an integer value (for example,
useful when animating whichChoice in a Switch node).
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, trigger output of integer value.
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. |
| integerKey |
[integerKey accessType inputOutput, type SFInt32 CDATA #FIXED "-1"]
integerKey is value for output when triggered.
Hint: directly setting a new value for the integerKey field generates a corresponding
integerKey output event. |
| triggerValue |
[triggerValue accessType outputOnly, type SFInt32 CDATA #FIXED ""]
triggerValue provides integer event output matching integerKey when true set_boolean
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 |
|
IS |
[X3D statement]
The IS statement connects node fields defined inside a ProtoBody declaration back
to corresponding ProtoInterface fields. To define each Prototype connection between
a ProtoInterface field and a ProtoBody node field, add one or more connect statements
within each IS statement.
Warning: IS statements are only allowed within a ProtoBody definition scope, which follows
ProtoInterface field declarations, and thus are only found within a ProtoDeclare statement.
Hint: if present, an IS statement is the first child within any other node.
Hint: an IS statement precedes any sibling Metadata* node, which in turn precedes any
other sibling nodes.
Hint: see the connect and ProtoBody statements.
Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PROTOdefinitionsemantics
Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| connect |
[X3D statement connect]
When inside a ProtoBody declaration and an IS statement, add a connect statement
to define event-routing connections between a parent node's field to a corresponding
ProtoInterface field.
Hint: any matching field type can be connected, including SFNode or MFNode.
Hint: if provided, value of the outer ProtoInstance fieldValue overrides default value
of inner IS/connect nodeField (defined within the original prototype declaration)
when first creating a new ProtoInstance node.
Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PROTOdefinitionsemantics
Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes |
| 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 |
IsoSurfaceVolumeData |
(X3D version 3.3 or later) [inherits X3DVolumeDataNode]
IsoSurfaceVolumeData displays one or more surfaces extracted from a voxel dataset.
A surface is defined as the boundary between regions in the volume where the voxel
values are larger than a given value (the iso value) on one side of the boundary and
smaller on the other side, and the gradient magnitude is larger than surfaceTolerance.
Hint: IsoSurfaceVolumeData can contain a single Texture3D node with containerField='gradients'
that is used to provide explicit per-voxel gradient direction information for determining
surface boundaries, rather than having values implicitly calculated by the implementation.
Hint: IsoSurfaceVolumeData can contain another Texture3D node with containerField='voxels'
containing voxel data.
Hint: IsoSurfaceVolumeData can contain multiple VolumeStyle 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.
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 |
| gradients |
[gradients accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture3DNode]
Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D)
that provides explicit per-voxel gradient direction information for determining surface
boundaries, rather than having it implicitly calculated by the implementation. |
| renderStyle |
[renderStyle accessType inputOutput, type MFNode array, empty list] [X3DVolumeRenderStyleNode]
Multiple contained X3DVolumeRenderStyleNode nodes corresponding to each isosurface
that define specific rendering technique for this volumetric object.
Hint:
Warning: if not defined, no default renderStryle is defined. |
| voxels |
[voxels accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture3DNode]
Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D)
that provides raw voxel information utilized by corresponding rendering styles. Any
number of color components (1-4) may be defined. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| dimensions |
[dimensions accessType inputOutput, type SFVec3f CDATA "1 1 1"]
Actual-size X-Y-Z dimensions of volume data in local coordinate system. |
| contourStepSize |
[contourStepSize accessType inputOutput, type SFFloat CDATA "0"]
If contourStepSize is non-zero, also render all isosurfaces that are multiples of
that step size from initial surface value.
Hint: contourStepSize can be negative so that steppping can proceed in a negative direction.
|
| surfaceTolerance |
[surfaceTolerance accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
Threshold for gradient magnitude for voxel inolusion in isosurface.
Hint: contained Texture3D node with containerField='gradients' can provide explicit per-voxel
gradient direction information for determining surface boundaries. |
| surfaceValues |
[surfaceValues accessType inputOutput, type MFFloat CDATA "0"]
If surfaceValues has one value defined, render corresponding isosurface plus any
isosurfaces based on contourStepSize. If surfaceValues has more than one value defined,
ignore contourStepSize and render surfaces corresponding to listed surfaceValues.
|
| 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 |
KeySensor |
[inherits X3DKeyDeviceSensorNode]
KeySensor generates events as the user presses keys on the keyboard. Browser support
includes the notion of "keyboard focus".
Hint: example scenes and authoring assets at https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter08UserInteractivity |
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. |
| 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. |
| keyPress |
[keyPress accessType outputOnly, type SFString CDATA #IMPLIED]
Events generated when user presses character-producing keys on keyboard produces
integer UTF-8 character values.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| keyRelease |
[keyRelease accessType outputOnly, type SFString CDATA #IMPLIED]
Events generated when user releases character-producing keys on keyboard produces
integer UTF-8 character values.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| actionKeyPress |
[actionKeyPress accessType outputOnly, type SFInt32 CDATA #IMPLIED]
action key press gives following values: HOME=000 END=1001 PGUP=1002 PGDN=1003 UP=1004
DOWN=1005 LEFT=1006 RIGHT=1007 F1..F12 = 1008..1019.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| actionKeyRelease |
[actionKeyRelease accessType outputOnly, type SFInt32 CDATA #IMPLIED]
action key release gives following values: HOME=000 END=1001 PGUP=1002 PGDN=1003
UP=1004 DOWN=1005 LEFT=1006 RIGHT=1007 F1..F12 = 1008..1019.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| shiftKey |
[shiftKey accessType outputOnly, type SFBool #IMPLIED]
shiftKey generates true event when pressed, false event when released.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| controlKey |
[controlKey accessType outputOnly, type SFBool #IMPLIED]
controlKey generates true event when pressed, false event when released.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| altKey |
[altKey accessType outputOnly, type SFBool #IMPLIED]
altKey generates true event when pressed, false event when released.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
Select geometry by activating the pointing device (for example, clicking the mouse)
to generate isActive events. Output event isActive=true is sent when geometry is selected
(for example, when primary mouse button is pressed), output event isActive=false is
sent when geometry is deselected (for example, when primary mouse button is released).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| 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 |
|
Layer |
(X3D version 3.2 or later) [inherits X3DLayerNode]
Layer contains a list of children nodes that define the contents of the layer.
Hint: no transformations are possible above each LayerSet/Layer combination in the scene
graph hierarchy.
Hint: each Layer node contains its own binding stacks and thus has its own viewpoints
and navigation. |
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. |
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DChildNode]
Nodes making up this layer.
Hint: no transformations are possible above each LayerSet/Layer combination in 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 |
| viewport |
[viewport accessType inputOutput, type SFNode singleton, NULL node] [X3DViewportNode]
The viewport field is a single Viewport node that constrains layer output to a sub-region
of the render surface. |
| objectType |
[objectType accessType inputOutput, type MFString CDATA ( ALL|NONE|TERRAIN|... ) "ALL"]
The objectType field specifies a set of labels used in the picking process. Each
string specified is treated as an independent label that needs to be matched against
the same type in one of the pick sensor instances.
Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to
intersect a pick sensor with objectType value "GROUND" fails since the objectType
values do not match.
Example: the special value "ALL" means that each node is available for picking regardless
of the type specified by the pick sensor.
Example: the special value "NONE" effectively disables all picking for this node and is the
equivalent of setting the pickable field to false.
Hint: authors may define any value for objectType.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks". |
| pickable |
[pickable accessType inputOutput, type SFBool (true|false) "true"]
pickable determines whether pick traversal is performed for this layer. |
| 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 |
|
LayerSet |
(X3D version 3.2 or later) [inherits X3DNode]
LayerSet defines a list of layers and a rendering order. The rendering order is
specified by the order field.
Hint: the layer first specified in the order field is the first layer rendered and appears
below any other layers. The layer last specified in the order field is the last layer
rendered and correspondingly appears on top of all other layers.
Warning: only one LayerSet node is allowed in a scene, and it shall be a root node at the
top of the scene graph.
Hint: X3D Architecture 35.2.1 Overview of layering https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/layering.html#OverviewOfLayering |
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. |
| layers |
[layers accessType inputOutput, type MFNode array, empty list] [X3DLayerNode]
The layers list defines a list of Layer nodes that contain the constituent parts
of the scene. Each layer is assigned an ordinal number depending on its position in
this contained list of nodes.
Hint: Ordinal values start with the numeral 1 representing the first item in the list.
Hint: nodes that are not part of a layer are considered to be in layer 0. |
| activeLayer |
[activeLayer accessType inputOutput, type SFInt32 CDATA "0"] [0,+β)
activeLayer field specifies the layer in which navigation takes place.
Hint: nodes that are not part of a layer are considered to be in layer 0. |
| order |
[order accessType inputOutput, type MFInt32 CDATA "0"] [0,+β)
The order list defines the order in which layers are rendered. Each value corresponds
to the ordinals of the layers.
Hint: the order list may contain repetitions of ordinal values, in which case the layer
is rendered again.
Warning: if order contains number values that are not ordinals assigned to layers, such numbers
are ignored.
Warning: layers that are not included in the order list are not rendered. |
| 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 |
| 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 |
|
Layout |
(X3D version 3.2 or later) [inherits X3DLayoutNode]
Layout node is used as layout field of LayoutLayer and LayoutGroup nodes. Layout
provides all parameters required to define the size, location and scale of a 2D rectangular
region.
Hint: the align, offset, and offsetUnits fields are used to determine the location of
the layout region. |
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. |
| align |
[align accessType inputOutput, type MFString CDATA ( LEFT|CENTER|RIGHT ) ( BOTTOM|CENTER|TOP ) "CENTER" "CENTER"]
The align field values align the sized rectangle to an edge or center of the parent
rectangle. Two quoted string values are provided. The first value is for horizontal
direction (LEFT|CENTER|RIGHT) and the second value is for vertical direction (BOTTOM|CENTER|TOP).
Examples: "CENTER" "CENTER" (default value), "LEFT" "TOP" or "RIGHT" "BOTTOM".
Warning: two values (or possibly one value) only.
Warning: if the align field has only one value, that value shall be "CENTER" and apply both
horizontally and vertically.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks". |
| offset |
[offset accessType initializeOnly, type MFFloat CDATA 0 0] (-β,+β)
The values of the offset field are used to translate the location of this rectangle
after the initial alignment. The offsetUnits field specifies how to interpret the
offset field.
Warning: if only one value is provided, it applies equally to horizontal and vertical directions
(width and height). More than two values are not allowed. |
| offsetUnits |
[offsetUnits accessType inputOutput, type MFString CDATA ( WORLD|FRACTION|PIXEL ) "WORLD" "WORLD"]
The offsetUnits field values are used to interprete the offset values. Two quoted
string values are provided. The first value is for horizontal offset, and the second
value is for vertical offset.
Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".
Hint: If the value of the offsetUnits field is FRACTION, the size of the corresponding
dimension is interpreted as a fraction of the corresponding parentβs dimension.
Warning: if only one value is provided, it applies equally to horizontal and vertical directions
(width and height). More than two values are not allowed.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks". |
| scaleMode |
[scaleMode accessType inputOutput, type MFString CDATA ( NONE|FRACTION|STRETCH|PIXEL ) "NONE" "NONE"]
The scaleMode field specifies how the scale of the parent is modified. Two quoted
string values are provided. The first value is for horizontal scale and the second
value is for vertical scale.
Examples: "NONE" "NONE" (default value), "FRACTION" "FRACTION", "STRETCH" "STRETCH" or "PIXEL"
"PIXEL".
Hint: A scaleMode field value of NONE specifies that the corresponding scale value is
not modified. Instead, the scale is inherited from its parent. Since a LayoutLayer
node does not have a parent, the value of NONE reverts to FRACTION.
Hint: A scaleMode value of FRACTION specifies a scale in the corresponding direction so
that one unit is equal to the dimension (width or height) of this rectangle.
Hint: a scaleMode value of STRETCH specifies a scale in the corresponding direction such
that the resulting scale in the horizontal direction is equal to the scale in the
vertical direction, thus producing a uniform scale.
Hint: a value of PIXEL specifies a scale in the corresponding direction such that one
unit is equal to one pixel.
Warning: if only one value is provided, it applies equally to horizontal and vertical directions
(width and height). More than two values are not allowed.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks". |
| size |
[size accessType inputOutput, type MFFloat CDATA 1 1] (0,+β)
The two values in the size field define the width and height of the layout rectangle.
The sizeUnits field specifies how to interpret the size values.
Warning: if only one value is provided, it applies equally to horizontal and vertical directions
(width and height). More than two values are not allowed. |
| sizeUnits |
[sizeUnits accessType inputOutput, type MFString CDATA ( WORLD|FRACTION|PIXEL ) "WORLD" "WORLD"]
The sizeUnits field values are used to interprete the offset values. Two quoted
string values are provided. The first value is for horizontal size, and the second
value is for vertical size.
Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".
Hint: If the value of the sizeUnits field is FRACTION, the size of the corresponding dimension
is interpreted as a fraction of the corresponding parentβs dimension.
Warning: if only one value is provided, it applies equally to horizontal and vertical directions
(width and height). More than two values are not allowed.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks". |
| 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 |
|
LayoutGroup |
(X3D version 3.2 or later) [inherits X3DGroupingNode, implements X3DVisibleObject]
LayoutGroup is a Grouping node that can contain most nodes, whose children are related
by a common layout within a parent layout.
The layout field contains an X3DLayoutNode node that provides the information required
to locate and size the layout region of the LayoutGroup node relative to its parentβs
layout region. LayoutGroup content is clipped by the specified viewport node.
Hint: The origin of the node is always in the center of its layout region. Thus, children
(with the exception of LayoutGroup) are specified in a coordinate system whose origin
is located at the center of the rectangle and can be transformed from that location.
Warning: a LayoutGroup can only be a child of a LayoutLayer node or another LayoutGroup node.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: LayoutGroup does not directly have any pixel-dependent concepts. However, it can
contain a Layout node that does have pixel-specific options. |
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 |
| layout |
[layout accessType inputOutput, type SFNode singleton, NULL node] [X3DLayoutNode]
The layout field contains an X3DLayoutNode node that provides the information required
to locate and size the layout region of the LayoutGroup node relative to its parentβs
layout region, and also to scale the contents of the LayoutGroup. |
| viewport |
[viewport accessType inputOutput, type SFNode singleton, NULL node] [X3DViewportNode]
The content of the LayoutGroup is clipped by the specified viewport. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding
box position offset from origin of local coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization
of large detailed models, with a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/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 |
|
LayoutLayer |
(X3D version 3.2 or later) [inherits X3DLayerNode]
LayoutLayer is a Grouping node that can contain most nodes. LayoutLayer content
is clipped by the specified viewport node.
Hint: insert a Shape node before adding geometry or Appearance.
Warning: better functional description needed in X3D specification. |
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 |
| layout |
[layout accessType inputOutput, type SFNode singleton, NULL node] [X3DLayoutNode]
The layout field contains an X3DLayoutNode node that provides the information required
to locate and size the layout region of the LayoutGroup node relative to its parentβs
layout region, and also to scale the contents of the LayoutGroup. |
| viewport |
[viewport accessType inputOutput, type SFNode singleton, NULL node] [X3DViewportNode]
The content of the LayoutGroup is clipped by the specified viewport. |
| 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. |
| objectType |
[objectType accessType inputOutput, type MFString CDATA ( ALL|NONE|TERRAIN|... ) "ALL"]
The objectType field specifies a set of labels used in the picking process. Each
string specified is treated as an independent label that needs to be matched against
the same type in one of the pick sensor instances.
Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to
intersect a pick sensor with objectType value "GROUND" fails since the objectType
values do not match.
Example: the special value "ALL" means that each node is available for picking regardless
of the type specified by the pick sensor.
Example: the special value "NONE" effectively disables all picking for this node and is the
equivalent of setting the pickable field to false.
Hint: authors may define any value for objectType.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks". |
| pickable |
[pickable accessType inputOutput, type SFBool (true|false) "true"]
pickable determines whether pick traversal is performed for this layer. |
| 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 |
LinePickSensor |
(X3D version 3.2 or later) [inherits X3DPickSensorNode]
LinePickSensor uses one or more pickingGeometry line segments to compute intersections
with pickTarget shapes. As each line intersection generates a known point in space,
useful event information is returned including normal, geometry and texCoord values.
Hint: sort order for line picking is based on each pair of coordinates that defining a
line segment, with first declared vertex of the segment defined to be the start of
the line to which the intersection points are closest.
Hint: when the picking line segment intersects a coplanar polygon, computed intersection
point(s) are illustrated in Figure 38.1 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/picking.html#f-LineIntersection
Hint: picking is performed between rendered frames of the event model. An author sets
up the picking request in one frame by placing a LinePickSensor in the desired location.
At the start of the next frame, any picking intersections are reported by the pick
sensor.
Hint: picking notification is performed at the start of the frame for all enabled pick
sensors once all other sensors are processed.
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
Warning: order of contained nodes is significant, single pickingGeometry node must precede
pickTarget node array.
Hint: IndexedLineSet or Lineset can be used for pickingGeometry node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| pickingGeometry |
[pickingGeometry accessType inputOutput, type SFNode singleton, NULL node] [IndexedLineSet | LineSet]
pickingGeometry specifies the exact geometry coordinates that are used to perform
the intersection testing of the picking operation. |
| pickTarget |
[pickTarget accessType inputOutput, type MFNode array, empty list] [X3DGroupingNode | X3DShapeNode | Inline]
pickTarget specifies the list of nodes against which picking operations are performed.
All nodes declared in this field and their descendents are evaluated for intersections.
|
| pickedGeometry |
[pickedGeometry accessType outputOnly, type MFNode #FIXED ""]
Output event containing the node or nodes that have been found to intersect with
the picking geometry from the last time this node performed a picking operation, given
in the local coordinate system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| 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 indicates when the intersecting object is picked by the picking geometry.
Output event isActive=true gets sent once a picked item is found. Output event isActive=false
gets sent once no picked item is found.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| intersectionType |
[intersectionType accessType initializeOnly, type SFString CDATA ( GEOMETRY|BOUNDS ) "BOUNDS"]
intersectionType specifies precision of the collision computation.
Hint: intersectionType constants may be extended by the browser to provide additional
options.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| matchCriterion |
[matchCriterion accessType inputOutput, type SFString CDATA ( MATCH_ANY|MATCH_EVERY|MATCH_ONLY_ONE ) "MATCH_ANY"]
defines whether the intersection test (i.e. pick) by this X3DPickSensorNode must
match one or more objectType. Specifically MATCH_ANY means any match of objectType
values is acceptable, MATCH_EVERY means that every objectType value in this node shall
match an objectType value in the X3DPickableObject, and MATCH_ONLY_ONE means that
one and only one objectType value can match. |
| objectType |
[objectType accessType inputOutput, type MFString CDATA ( ALL|NONE|TERRAIN|... ) "ALL"]
The objectType field specifies a set of labels used in the picking process. Each
string specified is treated as an independent label that needs to be matched against
the same type in one of the pick sensor instances.
Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to
intersect a pick sensor with objectType value "GROUND" fails since the objectType
values do not match.
Example: the special value "ALL" means that each node is available for picking regardless
of the type specified by the pick sensor.
Example: the special value "NONE" effectively disables all picking for this node and is the
equivalent of setting the pickable field of the corresponding PickableGroup to false.
Hint: authors may define any value for objectType.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks". |
| sortOrder |
[sortOrder accessType initializeOnly, type SFString CDATA ( ANY|CLOSEST|ALL|ALL_SORTED|... ) "CLOSEST"]
The sortOrder field determines the order provided for picked output events.
Example: ANY means any single object that can satisfy picking conditions for this pick sensor.
Consistency of results is not guaranteed.
Example: ALL means that every object that satisfies the picking conditions for this pick
sensor shall be returned.
Example: ALL_SORTED means that every object that satisfies the picking conditions for this
pick sensor shall be returned with the order of the output fields provided in a distance-sorted
order from closest to farthest away. The exact algorithm for sorting is defined by
the individual node definitions.
Example: CLOSEST means that the closest object by distance that satisfies the conditions
of this pick sensor. *The exact algorithm for distance determination shall be defined
by individual node definitions*.
Hint: browser implementations may define additional values and algorithms beyond these
four required values.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| pickedPoint |
[pickedPoint accessType outputOnly, type MFVec3f CDATA #FIXED ""]
Output event containing 3D points on surface of underlying pickingGeometry computed
by the picking intersection computations, given in the local coordinate system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| pickedNormal |
[pickedNormal accessType outputOnly, type MFVec3f CDATA #FIXED ""]
Output event containing surface normal vectors computed by the picking intersection
computations.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| pickedTextureCoordinate |
[pickedTextureCoordinate accessType outputOnly, type MFVec3f CDATA #FIXED ""]
Output event containing 3D texture coordinates of surfaces computed by the picking
intersection computations. Picked texture coordinates are in three dimensions. If
the target texture coordinate has two dimensions, the third coordinate (z component
of an SFVec3f) shall be zero.
Warning: if the target object has multiple textures defined, only texture coordinates for
the first texture are returned and all other textures are ignored.
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 |
|
LineProperties |
[inherits X3DAppearanceChildNode]
LineProperties allows precise fine-grained control over the rendering style of lines
and edges for associated geometry nodes inside the same Shape.
Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related
shapes in a scene.
Hint: LineProperties illustration model https://X3dGraphics.com/examples/X3dForWebAuthors/Chapter05AppearanceMaterialTextures/LinePropertiesExampleIndex.html
Warning: requires X3D profile='Full' or else include <component name='Shape' 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 |
| 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. |
| applied |
[applied accessType inputOutput, type SFBool (true|false) "true"]
Whether or not LineProperties are applied to associated geometry. |
| linetype |
[linetype accessType inputOutput, type SFInt32 CDATA "0"]
linetype selects a line pattern, with solid default if defined value isn't supported.
Values with guaranteed support are 1 Solid, 2 Dashed, 3 Dotted, 4 Dashed-dotted, 5
Dash-dot-dot. Optionally supported values are 6 single-headed arrow (arrow tip occurs
at last point of each individual list of points), 7 single dot, 8 double-headed arrow,
10 chain line, 11 center line, 12 hidden line, 13 phantom line, 14 break line 1, 15
break line 2, 16 User-specified dash pattern.
Hint: detailed descriptions of lineType values are found at the ISO/IEC 9973 International
Register of Graphical Items https://www.iso.org/jtc1/sc24/register at https://isotc.iso.org/livelink/livelink/fetch/-8916524/8916549/8916590/6208440/class_pages/linetype.html |
| linewidthScaleFactor |
(X3D version 3.1 or later) [linewidthScaleFactor accessType inputOutput, type SFFloat CDATA "0"]
linewidthScaleFactor is a scale factor multiplied by browser-dependent nominal linewidth,
mapped to nearest available line width. Values zero or less provide minimum available
line width. |
| containerField |
[containerField type NMTOKEN "lineProperties"]
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 |
|
LineSet |
[inherits X3DGeometryNode]
LineSet is a geometry node that can contain a Coordinate|CoordinateDouble node and
optionally a Color|ColorRGBA node.
Hint: Polygonal chain https://en.wikipedia.org/wiki/Polygonal_chain
Hint: either values in a contained Color node, or else Material emissiveColor in corresponding
Appearance node, are used for rendering lines and points.
Warning: lines are not lit, are not texture-mapped, and do not participate in collision detection.
Warning: use a different color (or 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: step-wise variation or linear interpolation of color values can be used as a good
scientific visualization technique to map arbitrary function values to a color map.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content.
Hint: consider including Fog (with Fog color matching Background color) to provide further
depth cueing for LineSet (LS). |
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 |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| 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. |
| vertexCount |
[vertexCount accessType initializeOnly, type MFInt32 CDATA #IMPLIED] [2,+β)
vertexCount describes how many vertices are used in each individual polyline segment
from the Coordinate point values. Coordinate point values are assigned as a block
of points to each line by taking vertexCount[n] vertices at a time. |
| 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 |
ListenerPointSource |
[inherits X3DSoundSourceNode]
ListenerPointSource node represents position and orientation of a person listening
to virtual sound in the audio scene, and provides single or multiple sound channels
as output. Multiple ListenerPointSource nodes can be active for sound processing.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#audiolistener |
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. |
| 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. |
| dopplerEnabled |
[dopplerEnabled accessType inputOutput, type SFBool (true|false) "false"]
dopplerEnabled enables/disables whether real-time Doppler effects (due to relation
motion between sources and listeners) are computed by browser between virtual sound
sources and active listening locations, then applied to received frequency at active
listening locations.
Hint: functional support requires player support for Sound component level 3.
Hint: Wikipedia Doppler effect https://en.wikipedia.org/wiki/Doppler_effect |
| 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. |
| interauralDistance |
[interauralDistance accessType inputOutput, type SFFloat CDATA "1"] [0,+β)
The interauralDistance field is . |
| orientation |
[orientation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Rotation (axis, angle in radians) of listening point direction relative to default
-Z axis direction in local coordinate system.
Warning: for VR/AR/MR/XR users wearing a head-mounted display (HMD), animating this field
may induce motion sickness.
Hint: this is orientation _change_ from default direction (0 0 -1) along the -X axis.
Hint: complex rotations can be accomplished axis-by-axis using parent Transforms. |
| position |
[position accessType inputOutput, type SFVec3f CDATA "0 0 10"]
position (x, y, z in meters) relative to local coordinate system. |
| trackCurrentView |
[trackCurrentView accessType inputOutput, type SFBool (true|false) "true"]
If trackCurrentView field is true then position and orientation match avatar's (user's)
current view. |
| 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 |
LoadSensor |
[inherits X3DNetworkSensorNode]
LoadSensor generates events as watchList child nodes are either loaded or fail to
load. Changing watchlist child nodes restarts the LoadSensor.
Hint: use multiple LoadSensor nodes to track multiple loading nodes individually.
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.
Warning: children (watchList) child nodes are not rendered, so normally USE copies of other
nodes to sense load status.
Hint: use Inline 'load' field to prompt or defer loading.
Warning: new X3D node, not supported in VRML97.
Hint: example scenes and authoring assets at https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter12EnvironmentSensorSound
Warning: 'children' field originally named 'watchList' in 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] [X3DUrlObject]
The children field monitors one or more USE nodes that contain a valid url field.
Warning: field originally named 'watchList' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
Hint: if watchList contains multiple USE nodes, output events are only generated when
all children have loaded successfully or at least one node has failed.
Hint: if individual load status information is desired for different nodes, multiple LoadSensor
nodes may be used, each with a single watchList element.
Hint: Anchor nodes can be monitored for binding a target Viewpoint, loading a new scene,
or loading a new scene in a new window. |
| 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. |
| timeOut |
[timeOut accessType inputOutput, type SFTime CDATA "0" #IMPLIED]
Time in seconds of maximum load duration prior to declaring failure. Default value
zero means use browser defaults. |
| 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. |
| isLoaded |
[isLoaded accessType outputOnly, type SFBool #FIXED ""]
Notify when all watchList child nodes are loaded, or at least one has failed. Sends
true on successfully loading all watchList child nodes. Sends false on timeOut of
any watchList child nodes, failure of any watchList child nodes to load, or no local
copies available and no network present.
Hint: use multiple LoadSensor nodes to track multiple loading nodes individually.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| loadTime |
[loadTime accessType outputOnly, type SFTime CDATA #FIXED ""]
Time of successful load complete, not sent on failure.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| progress |
[progress accessType outputOnly, type SFFloat CDATA #FIXED ""] [0,1]
Sends 0.0 on start and 1.0 on completion. Intermediate values are browser dependent
and always increasing (may indicate fraction of bytes, fraction of expected time or
another metric).
Hint: only 0 and 1 events are guaranteed.
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 |
|
LocalFog |
[inherits X3DChildNode, implements X3DFogObject]
LocalFog simulates atmospheric effects by blending distant objects with fog color.
LocalFog effects occur around the local transformation center, rather than bound to
the viewer.
The nearest LocalFog node within range takes precedence over other LocalFog and Fog
nodes.
Hint: LocalFog effects are based on its position in the world, as given by current transformation
hierarchy.
Hint: LocalFog effects remain independent of current view location.
Warning: LocalFog only affects geometry within the same scene subgraph.
Warning: LocalFog is not a bindable node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| color |
[color accessType inputOutput, type SFColor CDATA "1 1 1"] [0,1]
Fog color.
Hint: match Background color to make objects fade away.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| fogType |
[fogType accessType inputOutput, type SFString CDATA (LINEAR|EXPONENTIAL) LINEAR]
Specifies algorithm for rate of increasing Fog, either LINEAR or EXPONENTIAL.
Hint: EXPONENTIAL is more natural but also more computationally expensive.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| visibilityRange |
[visibilityRange accessType inputOutput, type SFFloat CDATA "0.0"]
Distance in meters where objects are totally obscured by the fog, using local coordinate
system.
Hint: visibilityRange 0 disables Fog. |
| 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 |
LOD |
[inherits X3DGroupingNode, implements X3DVisibleObject]
LOD (Level Of Detail) uses camera-to-object distance to switch among contained child
levels.
(Contained nodes are now called 'children' rather than 'level',
for consistent naming among all GroupingNodeType nodes.)
LOD range values go from near to far (as child geometry gets simpler for better performance).
For n range values, you must have n+1 children levels!
Only currently selected children level is rendered, but all levels continue to send/receive
events.
Hint: can add <WorldInfo info='null node'/> as a nonrendering, invisible final (or initial
or intermediate) child node that also documents the LOD switch-over rationale.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more
than one of these nodes can be bound and active at a given time.
Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch,
instead use ViewpointGroup as parent to constrain location proximity where the viewpoint
is available to user.
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: security mechanisms such as encryption and authentication can be applied to high
levels of detail, allowing authors to protect intellectual property at high resolution
for authorized users while still rendering simple unrestricted models for other users.
Warning: nested LOD (and/or GeoLOD) nodes with overlapping range intervals can lead to unexpected
or undefined behavior.
Hint: contained nodes must have type X3DChildNode, such as Group or Transform or Shape.
Warning: LOD is not allowed as a direct parent of Appearance, Material, Color, Coordinate,
Normal or Texture nodes, instead ensure that a Shape is present.
Hint: apply containerField='shape' if parent node is CADFace.
Hint: ConformanceNist X3D Examples Archive https://www.web3d.org/x3d/content/examples/ConformanceNist/SpecialGroups/LOD |
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. |
| forceTransitions |
[forceTransitions accessType initializeOnly, type SFBool (true|false) "false"]
Whether to perform every range-based transition, regardless of browser optimizations
that might otherwise occur. |
| center |
[center accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Viewpoint distance-measurement offset from origin of local coordinate system, used
for LOD node distance calculations. |
| range |
[range accessType initializeOnly, type MFFloat CDATA #IMPLIED] (0,+β)
Specifies ideal distances at which to switch between levels. The range field is
a floating-point array of camera-to-object distance transitions for each child level,
where range values go from near to far. For n range values, you must have n+1 child
levels!
Hint: can add <WorldInfo info='null node'/> as a nonrendering, invisible final (or initial
or intermediate) child node that also documents the LOD switch-over rationale.
Hint: not setting range values indicates that level switching can be optimized automatically
based on performance. |
| 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. |
| level_changed |
[level_changed accessType outputOnly, type SFInt32 CDATA #FIXED ""]
Output event that reports current level of LOD children whenever switching occurs.
Hint: LOD level index counting starts at zero. Thus level_changed value of -1 means no
choice, 0 means initial child, 1 means second child, etc.
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|proxy|rootNode|shape|skin) "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 |
Material |
[inherits X3DOneSidedMaterialNode]
Material specifies surface rendering properties for associated geometry nodes.
Material attributes are used by the X3D lighting equations during rendering.
Hint: insert Shape and Appearance nodes before adding material.
Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related
shapes in a scene.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
Hint: X3D Example Archives, Basic, Universal Media Materials https://www.web3d.org/x3d/content/examples/Basic/UniversalMediaMaterials
Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/lighting.html#Lightingmodel
Hint: Rendering https://en.wikipedia.org/wiki/Rendering_(computer_graphics)
Hint: 3D rendering https://en.wikipedia.org/wiki/3D_rendering
Hint: Physically based rendering (PBR) https://en.wikipedia.org/wiki/Physically_based_rendering |
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. |
| ambientIntensity |
[ambientIntensity accessType inputOutput, type SFFloat CDATA "0.2"] [0,1]
how much ambient omnidirectional light is reflected from all light sources. Interchange
profile
Hint: this field may be ignored, applying the default value regardless. |
| ambientTexture |
[ambientTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying ambientIntensity for this material node, the contained texture provides
Physically Based Rendering (PBR) modulation for each pixel.
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='ambientTexture' |
| ambientTextureMapping |
[ambientTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| diffuseColor |
[diffuseColor accessType inputOutput, type SFColor CDATA "0.8 0.8 0.8"] [0,1]
how much direct, angle-dependent light is reflected from all light sources.
Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet. |
| diffuseTexture |
[diffuseTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying diffuseColor for this material node, the contained texture provides
Physically Based Rendering (PBR) modulation for each pixel.
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='diffuseTexture' |
| diffuseTextureMapping |
[diffuseTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| emissiveColor |
[emissiveColor accessType inputOutput, type SFColor CDATA "0 0 0"] [0,1]
how much glowing light is emitted from this object.
Hint: emissiveColors glow even when all lights are off.
Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
Warning: bright emissiveColor values can wash out other colors and some textures. |
| emissiveTexture |
[emissiveTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying emissiveColor for this material node, the contained texture provides
Physically Based Rendering (PBR) modulation for each pixel.
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='emissiveTexture' |
| emissiveTextureMapping |
[emissiveTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| normalScale |
[normalScale accessType inputOutput, type SFFloat CDATA "1"] [0,β]
normalScale controls the degree to which normalTexture RGB values apply XYZ-normal
bump mapping to pixels in the parent material.
Hint: normalScale only affects computation of normalTexture modulations that affect lighting
of characteristics of the parent Material and has no relation to normal vectors defined
by corresponding geometry.
Hint: normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping |
| normalTexture |
[normalTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying normalScale for this material node, the contained texture modulates
the texture across the surface.
Hint: normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='normalTexture' |
| normalTextureMapping |
[normalTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| occlusionStrength |
[occlusionStrength accessType inputOutput, type SFFloat CDATA "1"] [0,1]
occlusionStrength indicates areas of indirect lighting, typically called ambient
occlusion. Higher values indicate areas that should receive full indirect lighting
and lower values indicate no indirect lighting.
Hint: only the Red channel of the texture is used for occlusion computations, other channels
are ignored.
Hint: https://en.wikipedia.org/wiki/Ambient_occlusion |
| occlusionTexture |
[occlusionTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying occlusionStrength for this material node, the contained texture provides
Physically Based Rendering (PBR) modulation for each pixel.
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='occlusionTexture' |
| occlusionTextureMapping |
[occlusionTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| shininess |
[shininess accessType inputOutput, type SFFloat CDATA "0.2"] [0,1]
Lower shininess values provide soft specular glows, while higher values result in
sharper, smaller highlights. Interchange profile
Hint: this field may be ignored, applying the default value regardless. |
| shininessTexture |
[shininessTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying shininess for this material node, the contained texture provides Physically
Based Rendering (PBR) modulation for each pixel.
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='shininessTexture' |
| shininessTextureMapping |
[shininessTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| specularColor |
[specularColor accessType inputOutput, type SFColor CDATA "0 0 0"] [0,1]
specular highlights are brightness reflections (example: shiny spots on an apple).
Interchange profile
Hint: this field may be ignored, applying the default value regardless. |
| specularTexture |
[specularTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying specularColor for this material node, the contained texture provides
Physically Based Rendering (PBR) modulation for each pixel.
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='specularTexture' |
| specularTextureMapping |
[specularTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| transparency |
[transparency accessType inputOutput, type SFFloat CDATA "0"] [0,1]
how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque.
Interchange profile
Hint: transparency < .5 opaque, transparency > .5 transparent. |
| containerField |
[containerField type NMTOKEN "material"]
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 |
Matrix3VertexAttribute |
(X3D version 3.1 or later) [inherits X3DVertexAttributeNode]
Matrix3VertexAttribute defines a set of per-vertex 3x3 matrix attributes. |
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. |
| name |
[name accessType initializeOnly, type NMTOKEN #REQUIRED]
Required name for this particular VertexAttribute instance.
Warning: name is not specified if this instance is a USE node.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| value |
[value accessType inputOutput, type MFMatrix3f CDATA ""]
value specifies an arbitrary collection of matrix values that will be passed to
the shader as per-vertex information.
Hint: the length of the value field shall be a multiple of numComponents. |
| containerField |
[containerField type NMTOKEN "attrib"]
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 |
Matrix4VertexAttribute |
(X3D version 3.1 or later) [inherits X3DVertexAttributeNode]
Matrix4VertexAttribute defines a set of per-vertex 4x4 matrix attributes. |
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. |
| name |
[name accessType initializeOnly, type NMTOKEN #REQUIRED]
Required name for this particular VertexAttribute instance.
Warning: name is not specified if this instance is a USE node.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| value |
[value accessType inputOutput, type MFMatrix4f CDATA ""]
value specifies an arbitrary collection of matrix values that will be passed to
the shader as per-vertex information.
Hint: the length of the value field shall be a multiple of numComponents. |
| containerField |
[containerField type NMTOKEN "attrib"]
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 |
meta |
[X3D statement]
The meta statement provides metadata information about the X3D model, following
the same naming conventions as HTML's meta tag.
The name and content attributes together define key=value metadata pairs.
Hint: X3D XML Encoding https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#Header
Hint: X3D Scene Authoring Hints, meta Statements https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#metaStatements
Hint: W3C HTML5 Recommendation, 4.2.5 The meta element https://www.w3.org/TR/html5/document-metadata.html#the-meta-element
Warning: the META statement is capitalized in the X3D Architecture specification and in the
X3D ClassicVRML Encoding.
Hint: X3D Architecture 7.2.5.6 META statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#METAStatement |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| name |
[name type type CDATA #IMPLIED]
Keyword name of the meta attribute, following the same naming conventions as HTML's
meta tag.
Hint: for broadest searchability, use Dublin Core Metadata Initiative (DCMI) terms for
name values. https://www.dublincore.org/documents/dcmi-terms
Warning: Dublin Core Metadata Initiative (DCMI) requires name to be a token appendable to
a URI, so normal expectation for a typical name is type NMTOKEN with no whitespace.
Warning: if the name attribute is set, the http-equiv attribute should not be set.
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
Hint: HTML5 section 4.2.5.1. Standard metadata names https://www.w3.org/TR/html5/document-metadata.html#standard-metadata-names
Hint: HTML5 section 4.2.5.2. Other metadata names https://www.w3.org/TR/html5/document-metadata.html#other-metadata-names
Hint: WHATWG Wiki MetaExtensions https://wiki.whatwg.org/wiki/MetaExtensions
Warning: names are permitted to contain whitespace characters but might be inconsistent.
A name value containing whitespace might not validate or match other corresponding
values. |
| content |
[content type CDATA #REQUIRED]
The content attribute provides metadata information relevant to the name attribute
provided. The name and content attributes together define key=value metadata pairs.
Hint: for broadest searchability, use Dublin Core Metadata Initiative (DCMI) terms for
name values. https://www.dublincore.org/documents/dcmi-terms
Warning: Dublin Core Metadata Initiative (DCMI) requires name to be a token appendable to
a URI, so normal expectation for a typical name is type NMTOKEN with no whitespace.
Hint: alternatively the content attribute can support the http-equiv attribute.
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). |
| lang |
[lang type CDATA #IMPLIED]
Language code, as per [IETF BCP47/RFC5646]. https://www.rfc-editor.org/rfc/bcp/bcp47.txt and described in https://www.w3.org/International/questions/qa-http-and-lang
Hint: Language Subtag Lookup at http://people.w3.org/rishida/utils/subelements |
| dir |
[dir type ENUMERATION #IMPLIED (ltr|rtl)]
Direction for weak/neutral text (ltr=left-to-right, rtl=right-to-left). See http://www.w3.org/TR/html4/struct/dirlang.html#adef-dir |
| http-equiv |
[http-equiv type CDATA #IMPLIED]
The http-equiv attribute provides an HTTP header for the value of the content attribute.
Example: <meta http-equiv='Expires' content='Tue, 20 Aug 1996 14:25:27 GMT'>.
Hint: the http-equiv attribute can be used to simulate an HTTP response header.
Warning: if the name attribute is set, the http-equiv attribute should not be set.
Hint: see http://www.w3.org/TR/html4/struct/global.html#adef-http-equiv |
| scheme |
[scheme type CDATA #IMPLIED]
The scheme attribute allows authors to provide user agents more context for the
correct interpretation of meta information. For example, <meta scheme="ISBN" name="identifier"
content="0-8230-2355-9"> See http://www.w3.org/TR/html4/struct/global.html#idx-scheme |
| 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 |
|
MetadataBoolean |
(X3D version 3.3 or later) [inherits X3DNode, implements X3DMetadataObject]
MetadataBoolean contains a typed list of values providing metadata information about
its parent node.
Further information about this specific Metadata* node may be provided by a single
child Metadata* node with containerField="metadata".
Hint: typically use containerField="value" if the parent node is MetadataSet.
Warning: default containerField="metadata" in X3D 3 changed to default containerField="value"
in X3D 4.0, allowing construction of much terser MetadataSet vocabulary structures.
Hint: explicitly defining containerField for Metadata nodes is always allowed and also
unambiguous across each version of X3D.
Hint: each of the Metadata nodes are allowed as top-level root nodes in a scene, if doing
that be sure to explicitly define containerField='metadata'. https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-DIS/Part01/concepts.html#Rootnodes
Warning: Metadata nodes can only contain other Metadata nodes.
Hint: if present, an IS statement is the first child within any other node.
Hint: an IS statement precedes any sibling Metadata* node, which in turn precedes any
other sibling nodes.
Hint: comments are not readable when a model file is loaded for viewing, but WorldInfo
and Metadata* nodes are persistent and inspectable at run time.
Hint: X3D for Web Authors, Chapter 15, Metadata Information https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.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. |
| name |
[name accessType inputOutput, type SFString #IMPLIED]
Depending on the metadata vocabulary, the attribute name is usually required for
metadata nodes.
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 |
| value |
[value accessType inputOutput, type MFBool CDATA #IMPLIED]
The value attribute is a strictly typed data array providing relevant metadata information.
Warning: use lower-case values ("true false") for .x3d XML encoding, and upper-case values
("TRUE FALSE") for .x3dv ClassicVRML encoding. |
| reference |
[reference accessType inputOutput, type SFString CDATA #IMPLIED]
Reference to the metadata standard or definition defining this particular metadata
value. |
| containerField |
[containerField type NMTOKEN "metadata" is X3D3 default, "value" is X3D4 default]
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: set containerField="value" when part of a MetadataSet payload, otherwise use containerField="metadata"
when providing information about a parent node itself.
Warning: X3D3 default is 'metadata' while X3D4 default is 'value' in order to support terseness
of MetadataSet collections in X3D4.
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 |
|
MetadataDouble |
[inherits X3DNode, implements X3DMetadataObject]
MetadataDouble contains a typed list of values providing metadata information about
its parent node.
Further information about this specific Metadata* node may be provided by a single
child Metadata* node with containerField="metadata".
Hint: typically use containerField="value" if the parent node is MetadataSet.
Warning: default containerField="metadata" in X3D 3 changed to default containerField="value"
in X3D 4.0, allowing construction of much terser MetadataSet vocabulary structures.
Hint: explicitly defining containerField for Metadata nodes is always allowed and also
unambiguous across each version of X3D.
Hint: each of the Metadata nodes are allowed as top-level root nodes in a scene, if doing
that be sure to explicitly define containerField='metadata'. https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-DIS/Part01/concepts.html#Rootnodes
Warning: Metadata nodes can only contain other Metadata nodes.
Hint: if present, an IS statement is the first child within any other node.
Hint: an IS statement precedes any sibling Metadata* node, which in turn precedes any
other sibling nodes.
Hint: The choice of MetadataDouble versus MetadataFloat usually depends on the relevant
tool utilizing the value, or else the relevant metadata reference defining the value.
Hint: comments are not readable when a model file is loaded for viewing, but WorldInfo
and Metadata* nodes are persistent and inspectable at run time.
Hint: X3D for Web Authors, Chapter 15, Metadata Information https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.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. |
| name |
[name accessType inputOutput, type SFString #IMPLIED]
Depending on the metadata vocabulary, the attribute name is usually required for
metadata nodes.
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 |
| value |
[value accessType inputOutput, type MFDouble CDATA #IMPLIED]
The value attribute is a strictly typed data array providing relevant metadata information.
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). |
| reference |
[reference accessType inputOutput, type SFString CDATA #IMPLIED]
Reference to the metadata standard or definition defining this particular metadata
value. |
| containerField |
[containerField type NMTOKEN "metadata" is X3D3 default, "value" is X3D4 default]
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: set containerField="value" when part of a MetadataSet payload, otherwise use default
value "metadata" when providing information about a parent node itself.
Warning: X3D3 default is 'metadata' while X3D4 default is 'value' in order to support terseness
of MetadataSet collections in X3D4.
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 |
|
MetadataFloat |
[inherits X3DNode, implements X3DMetadataObject]
MetadataFloat contains a typed list of values providing metadata information about
its parent node.
Further information about this specific Metadata* node may be provided by a single
child Metadata* node with containerField="metadata".
Hint: typically use containerField="value" if the parent node is MetadataSet.
Warning: default containerField="metadata" in X3D 3 changed to default containerField="value"
in X3D 4.0, allowing construction of much terser MetadataSet vocabulary structures.
Hint: explicitly defining containerField for Metadata nodes is always allowed and also
unambiguous across each version of X3D.
Hint: each of the Metadata nodes are allowed as top-level root nodes in a scene, if doing
that be sure to explicitly define containerField='metadata'. https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-DIS/Part01/concepts.html#Rootnodes
Warning: Metadata nodes can only contain other Metadata nodes.
Hint: if present, an IS statement is the first child within any other node.
Hint: an IS statement precedes any sibling Metadata* node, which in turn precedes any
other sibling nodes.
Hint: The choice of MetadataDouble versus MetadataFloat usually depends on the relevant
tool utilizing the value, or else the relevant metadata reference defining the value.
Hint: comments are not readable when a model file is loaded for viewing, but WorldInfo
and Metadata* nodes are persistent and inspectable at run time.
Hint: X3D for Web Authors, Chapter 15, Metadata Information https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.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. |
| name |
[name accessType inputOutput, type SFString #IMPLIED]
Depending on the metadata vocabulary, the attribute name is usually required for
metadata nodes.
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 |
| value |
[value accessType inputOutput, type MFFloat CDATA #IMPLIED]
The value attribute is a strictly typed data array providing relevant metadata information.
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). |
| reference |
[reference accessType inputOutput, type SFString CDATA #IMPLIED]
Reference to the metadata standard or definition defining this particular metadata
value. |
| containerField |
[containerField type NMTOKEN "metadata" is X3D3 default, "value" is X3D4 default]
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: set containerField="value" when part of a MetadataSet payload, otherwise use default
value "metadata" when providing information about a parent node itself.
Warning: X3D3 default is 'metadata' while X3D4 default is 'value' in order to support terseness
of MetadataSet collections in X3D4.
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 |
|
MetadataInteger |
[inherits X3DNode, implements X3DMetadataObject]
MetadataInteger contains a typed list of values providing metadata information about
its parent node.
Further information about this specific Metadata* node may be provided by a single
child Metadata* node with containerField="metadata".
Hint: typically use containerField="value" if the parent node is MetadataSet.
Warning: default containerField="metadata" in X3D 3 changed to default containerField="value"
in X3D 4.0, allowing construction of much terser MetadataSet vocabulary structures.
Hint: explicitly defining containerField for Metadata nodes is always allowed and also
unambiguous across each version of X3D.
Hint: each of the Metadata nodes are allowed as top-level root nodes in a scene, if doing
that be sure to explicitly define containerField='metadata'. https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-DIS/Part01/concepts.html#Rootnodes
Warning: Metadata nodes can only contain other Metadata nodes.
Hint: if present, an IS statement is the first child within any other node.
Hint: an IS statement precedes any sibling Metadata* node, which in turn precedes any
other sibling nodes.
Hint: comments are not readable when a model file is loaded for viewing, but WorldInfo
and Metadata* nodes are persistent and inspectable at run time.
Hint: X3D for Web Authors, Chapter 15, Metadata Information https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.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. |
| name |
[name accessType inputOutput, type SFString #IMPLIED]
Depending on the metadata vocabulary, the attribute name is usually required for
metadata nodes.
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 |
| value |
[value accessType inputOutput, type MFInt32 CDATA #IMPLIED]
The value attribute is a strictly typed data array providing relevant metadata information.
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). |
| reference |
[reference accessType inputOutput, type SFString CDATA #IMPLIED]
Reference to the metadata standard or definition defining this particular metadata
value. |
| containerField |
[containerField type NMTOKEN "metadata" is X3D3 default, "value" is X3D4 default]
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: set containerField="value" when part of a MetadataSet payload, otherwise use default
value "metadata" when providing information about a parent node itself.
Warning: X3D3 default is 'metadata' while X3D4 default is 'value' in order to support terseness
of MetadataSet collections in X3D4.
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 |
|
MetadataSet |
[inherits X3DNode, implements X3DMetadataObject]
MetadataSet contains a list of Metadata* nodes that each have containerField="value"
and together provide information about the parent node of the MetadataSet.
Further information about this specific MetadataSet node may be provided by a single
child Metadata* node with containerField="metadata".
Hint: typically use containerField="value" if the parent node is MetadataSet.
Warning: default containerField="metadata" in X3D 3 changed to default containerField="value"
in X3D 4.0, allowing construction of much terser MetadataSet vocabulary structures.
Hint: explicitly defining containerField for Metadata nodes is always allowed and also
unambiguous across each version of X3D.
Hint: each of the Metadata nodes are allowed as top-level root nodes in a scene, if doing
that be sure to explicitly define containerField='metadata'. https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-DIS/Part01/concepts.html#Rootnodes
Warning: Metadata nodes can only contain other Metadata nodes.
Hint: if present, an IS statement is the first child within any other node.
Hint: an IS statement precedes any sibling Metadata* node, which in turn precedes any
other sibling nodes.
Hint: MetadataSet can contain other MetadataSet nodes.
Hint: comments are not readable when a model file is loaded for viewing, but WorldInfo
and Metadata* nodes are persistent and inspectable at run time.
Hint: X3D for Web Authors, Chapter 15, Metadata Information https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.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 |
| value |
[value accessType inputOutput, type MFNode array, empty list] [X3DNode]
The value field provides a list of X3DMetadataObject nodes whose meaning is determined
by the name field. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| name |
[name accessType inputOutput, type SFString #IMPLIED]
Depending on the metadata vocabulary, the attribute name is usually required for
metadata nodes.
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 |
| reference |
[reference accessType inputOutput, type SFString CDATA #IMPLIED]
Reference to the metadata standard or definition defining this particular metadata
value. |
| containerField |
[containerField type NMTOKEN "metadata" is X3D3 default, "value" is X3D4 default]
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: set containerField="value" when part of a MetadataSet payload, otherwise use default
value "metadata" when providing information about a parent node itself.
Warning: X3D3 default is 'metadata' while X3D4 default is 'value' in order to support terseness
of MetadataSet collections in X3D4.
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 |
|
MetadataString |
[inherits X3DNode, implements X3DMetadataObject]
MetadataString contains a typed list of values providing metadata information about
its parent node.
Further information about this specific Metadata* node may be provided by a single
child Metadata* node with containerField="metadata".
Hint: typically use containerField="value" if the parent node is MetadataSet.
Warning: default containerField="metadata" in X3D 3 changed to default containerField="value"
in X3D 4.0, allowing construction of much terser MetadataSet vocabulary structures.
Hint: explicitly defining containerField for Metadata nodes is always allowed and also
unambiguous across each version of X3D.
Hint: each of the Metadata nodes are allowed as top-level root nodes in a scene, if doing
that be sure to explicitly define containerField='metadata'. https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-DIS/Part01/concepts.html#Rootnodes
Warning: Metadata nodes can only contain other Metadata nodes.
Hint: if present, an IS statement is the first child within any other node.
Hint: an IS statement precedes any sibling Metadata* node, which in turn precedes any
other sibling nodes.
Hint: comments are not readable when a model file is loaded for viewing, but WorldInfo
and Metadata* nodes are persistent and inspectable at run time.
Hint: X3D for Web Authors, Chapter 15, Metadata Information https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.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. |
| name |
[name accessType inputOutput, type SFString #IMPLIED]
Depending on the metadata vocabulary, the attribute name is usually required for
metadata nodes.
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 |
| value |
[value accessType inputOutput, type MFString CDATA #IMPLIED]
The value attribute is a strictly typed data array providing relevant metadata information.
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). |
| reference |
[reference accessType inputOutput, type SFString CDATA #IMPLIED]
Reference to the metadata standard or definition defining this particular metadata
value. |
| containerField |
[containerField type NMTOKEN "metadata" is X3D3 default, "value" is X3D4 default]
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: set containerField="value" when part of a MetadataSet payload, otherwise use default
value "metadata" when providing information about a parent node itself.
Warning: X3D3 default is 'metadata' while X3D4 default is 'value' in order to support terseness
of MetadataSet collections in X3D4.
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 |
|
MicrophoneSource |
[inherits X3DSoundSourceNode]
MicrophoneSource captures input from a physical microphone in the real world.
Warning: multiple security and privacy condiderations need to be observed.
Hint: W3C Media Capture and Streams https://www.w3.org/TR/mediacapture-streams |
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. |
| 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. |
| mediaDeviceID |
[mediaDeviceID accessType outputOnly, type SFString CDATA #FIXED ""]
mediaDeviceID field provides ID parameter functionality. (TODO experimental) |
| 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 |
|
MotorJoint |
(X3D version 3.2 or later) [inherits X3DRigidJointNode]
MotorJoint drives relative angular velocities between body1 and body2 within a common
reference frame.
Contains two RigidBody nodes (containerField values body1, body2).
Hint: useful in combination with BallJoint.
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. |
| autoCalc |
[autoCalc accessType initializeOnly, type SFBool (true|false) "false"]
autoCalc controls whether user manually provides individual angle rotations each
frame (false) or if angle values are automatically calculated by motor implementations
(true). |
| axis1Angle |
[axis1Angle accessType inputOutput, type SFFloat CDATA "0"]
axis1Angle (radians) is rotation angle for corresponding motor axis when in user-calculated
mode.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| axis2Angle |
[axis2Angle accessType inputOutput, type SFFloat CDATA "0"]
axis2Angle (radians) is rotation angle for corresponding motor axis when in user-calculated
mode.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| axis3Angle |
[axis3Angle accessType inputOutput, type SFFloat CDATA "0"]
axis3Angle (radians) is rotation angle for corresponding motor axis when in user-calculated
mode.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| axis1Torque |
[axis1Torque accessType inputOutput, type SFFloat CDATA "0"]
axis1Torque is rotational torque applied by corresponding motor axis when in user-calculated
mode. |
| axis2Torque |
[axis2Torque accessType inputOutput, type SFFloat CDATA "0"]
axis2Torque is rotational torque applied by corresponding motor axis when in user-calculated
mode. |
| axis3Torque |
[axis3Torque accessType inputOutput, type SFFloat CDATA "0"]
axis3Torque is rotational torque applied by corresponding motor axis when in user-calculated
mode. |
| enabledAxes |
[enabledAxes accessType inputOutput, type SFInt32 CDATA "0"] [0,3]
enabledAxes indicates which motor axes are active. (0) none, (1) axis 1, (2) axes
1 and 2, (3) all three axes. |
| 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. |
| motor1Axis |
[motor1Axis accessType inputOutput, type SFVec3f CDATA "1 0 0"]
motor1Axis defines axis vector of corresponding motor axis.
Hint: 0 0 0 means motor disabled about this axis. |
| motor2Axis |
[motor2Axis accessType inputOutput, type SFVec3f CDATA "0 1 0"]
motor2Axis defines axis vector of corresponding motor axis.
Hint: 0 0 0 means motor disabled about this axis. |
| motor3Axis |
[motor3Axis accessType inputOutput, type SFVec3f CDATA "0 0 1"]
motor3Axis defines axis vector of corresponding motor axis.
Hint: 0 0 0 means motor disabled about this axis. |
| stop1Bounce |
[stop1Bounce accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stop1Bounce is velocity factor for bounce back once stop point is reached.
Hint: 0 means no bounce, 1 means return velocity matches. |
| stop2Bounce |
[stop2Bounce accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stop2Bounce is velocity factor for bounce back once stop point is reached.
Hint: 0 means no bounce, 1 means return velocity matches. |
| stop3Bounce |
[stop3Bounce accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stop3Bounce is velocity factor for bounce back once stop point is reached.
Hint: 0 means no bounce, 1 means return velocity matches. |
| stop1ErrorCorrection |
[stop1ErrorCorrection accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stop1ErrorCorrection is fraction of error correction performed during time step
once stop point is reached.
Hint: 0 means no error correction, 1 means all error corrected in single step. |
| stop2ErrorCorrection |
[stop2ErrorCorrection accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stop2ErrorCorrection is fraction of error correction performed during time step
once stop point is reached.
Hint: 0 means no error correction, 1 means all error corrected in single step. |
| stop3ErrorCorrection |
[stop3ErrorCorrection accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stop3ErrorCorrection is fraction of error correction performed during time step
once stop point is reached.
Hint: 0 means no error correction, 1 means all error corrected in single step. |
| motor1Angle |
[motor1Angle accessType outputOnly, type SFFloat CDATA]
motor1Angle provides calculated angle of rotation (radians) for this motor joint
from last frame.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| motor2Angle |
[motor2Angle accessType outputOnly, type SFFloat CDATA]
motor2Angle provides calculated angle of rotation (radians) for this motor joint
from last frame.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| motor3Angle |
[motor3Angle accessType outputOnly, type SFFloat CDATA]
motor3Angle provides calculated angle of rotation (radians) for this motor joint
from last frame.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| motor1AngleRate |
[motor1AngleRate accessType outputOnly, type SFFloat CDATA]
motor1AngleRate provides calculated anglular rotation rate (radians/second) for
this motor joint from last frame.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| motor2AngleRate |
[motor2AngleRate accessType outputOnly, type SFFloat CDATA]
motor2AngleRate provides calculated anglular rotation rate (radians/second) for
this motor joint from last frame.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| motor3AngleRate |
[motor3AngleRate accessType outputOnly, type SFFloat CDATA]
motor3AngleRate provides calculated anglular rotation rate (radians/second) for
this motor joint from last frame.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| 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 |
MovieTexture |
[inherits X3DTexture2DNode, implements X3DSoundSourceNode, X3DUrlObject]
MovieTexture applies a 2D movie image to surface geometry, or provides audio for
a Sound node.
First define as texture, then USE as Sound source to see it/hear it/save memory.
Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s,
t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.
Hint: can contain a single TextureProperties node.
Hint: insert Shape and Appearance nodes before adding texture.
Hint: provide a Viewpoint that allows a clear view of the MovieTexture so that users can
easily see all details.
Hint: utilize DEF/USE references for multiple copies of a single MovieTexture video file
in order to avoid multiple-download delays, reduce memory requirements, and maintain
synchronization.
Hint: authors can provide multiple video formats for the same video track, with each source
address listed separately in the url field.
Hint: player support for MPEG-1 video format is required, other formats are optional.
Warning: MovieTexture has containerField='texture' when parent is an Appearance node, otherwise
containerField='source' when parent is a Sound node.
Hint: Texture coordinates are reapplied (or else recomputed if textureTransform field
initially NULL) whenever the corresponding vertex-based geometry changes.
Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/lighting.html#Lightingmodel
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 |
| textureProperties |
[textureProperties accessType initializeOnly, type SFNode singleton, NULL node] [TextureProperties]
Single contained TextureProperties node that can specify additional visual attributes
applied to corresponding texture images. |
| 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 MovieTexture 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.
Warning: not supported in VRML97. |
| 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 MovieTexture 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.
Warning: not supported in VRML97. |
| repeatS |
[repeatS accessType initializeOnly, type SFBool (true|false) "true"]
Whether to repeat texture along S axis horizontally from left to right. |
| repeatT |
[repeatT accessType initializeOnly, type SFBool (true|false) "true"]
Whether to repeat texture along T axis vertically from top to bottom. |
| speed |
[speed accessType inputOutput, type SFFloat CDATA "1.0"]
Factor for how fast the movie (or soundtrack) is played.
Hint: a MovieTexture node shall display frame 0 if speed = 0.
Hint: a negative speed value sets the movie to play in reverse. |
| 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 movie file or stream. Multiple locations are more reliable,
and including a Web address lets e-mail attachments work.
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. 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 MovieTexture activated/running, cumulative in seconds,
and not counting any paused time.
Warning: not supported in VRML97.
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 MovieTexture is paused/resumed.
Warning: not supported in VRML97.
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 (texture|source|watchList|back|bottom|front|left|right|top|backTexture|bottomTexture|frontTexture|leftTexture|rightTexture|topTexture|baseTexture|emissiveTexture|metallicRoughnessTexture|normalTexture|occlusionTexture)
"texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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.
Warning: MovieTexture has containerField='texture' when parent is an Appearance node, otherwise
containerField='source' when parent is a Sound 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 |
|
MultiTexture |
[inherits X3DTextureNode]
MultiTexture applies several individual textures to a single geometry node, enabling
a variety of visual effects that include light mapping and environment mapping. MultiTexture
can contain zero or more ImageTexture, MovieTexture, PixelTexture, ComposedCubeMapTexture,
GeneratedCubeMapTexture, ImageCubeMapTexture, ComposedTexture3D, ImageTexture3D, and
PixelTexture3D nodes.
Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s,
t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.
Hint: insert Shape and Appearance nodes before adding texture.
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
Warning: the number of textures to be blended may have a significant impact on performance,
depending on available graphics hardware capabilities.
Hint: multitexturing is accomplished using MultiTexture, MultiTextureCoordinate and MultiTextureTransform
nodes.
Hint: Texture coordinates are reapplied (or else recomputed if textureTransform field
initially NULL) whenever the corresponding vertex-based geometry changes.
Hint: X3D Texturing component Figure 18.2 Lightmap example, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#f-Lightmapexample
Hint: X3D Texturing component Table 18.2: Comparison of single texture and multitexture
attributes, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-SingleAndMultitextureAttrs
Hint: MultiTexture does not need to be included in LoadSensor watchList since any child
ImageTexture and MovieTexture nodes of interest can be handled separately.
Warning: MultiTexture may not contain another MultiTexture node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| texture |
[texture accessType inputOutput, type MFNode array, empty list] [X3DSingleTextureNode]
Contained texture nodes (ImageTexture, MovieTexture, PixelTexture) that map image(s)
to surface geometry, defining each of the different texture channels.
Warning: MultiTexture may not contain another MultiTexture node.
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 |
| 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. |
| alpha |
[alpha accessType inputOutput, type SFFloat CDATA "1.0"] [0,1]
The alpha field defines the alpha (1-transparency) base value for mode operations.
|
| color |
[color accessType inputOutput, type SFColor CDATA "1 1 1"] [0,1]
The color field defines the RGB base values for mode operations.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| 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). |
| function |
[function accessType inputOutput, type MFString CDATA ( COMPLEMENT|ALPHAREPLICATE ) #IMPLIED]
function operators COMPLEMENT or ALPHAREPLICATE can be applied after the mode blending
operation. Empty string value "" indicates that no function operation is applied for
that stage.
Hint: include the same number of function values as textures, otherwise the default of
no function operation is applied for each remaining stage.
Hint: X3D Architecture Table 18.5 Values for the function field https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-ValuesForFunctionField for further details. |
| mode |
[mode accessType inputOutput, type MFString CDATA ( MODULATE|REPLACE|MODULATE2X|MODULATE4X|ADD|ADDSIGNED|ADDSIGNED2X|SUBTRACT|ADDSMOOTH
|BLENDDIFFUSEALPHA|BLENDTEXTUREALPHA|BLENDFACTORALPHA|BLENDCURRENTALPHA|MODULATEALPHA_ADDCOLOR|MODULATEINVALPHA_ADDCOLOR|MODULATEINVCOLOR_ADDALPHA|OFF|SELECTARG1|SELECTARG2|DOTPRODUCT3
) #IMPLIED]
mode field indicates the type of blending operation, both for color and for alpha
channel.
Hint: include the same number of mode values as textures, otherwise the default value
MODULATE is added for each remaining stage.
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 18.3 Multitexture modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-MultitextureModes for further details. |
| source |
[source accessType inputOutput, type MFString CDATA ( DIFFUSE|SPECULAR|FACTOR ) #IMPLIED]
source field determines whether each image source is treated as DIFFUSE, SPECULAR
or a multiplicative FACTOR. Empty string value "" indicates that no source modifier
is applied for that stage.
Hint: include the same number of source values as textures, otherwise the default of no
source interpretation is applied for each remaining stage.
Hint: X3D Architecture Table 18.4 Values for the source field https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-ValuesForSourceField for further details. |
| containerField |
[containerField type NMTOKEN (texture|back|bottom|front|left|right|top|backTexture|bottomTexture|frontTexture|leftTexture|rightTexture|topTexture|baseTexture|emissiveTexture|metallicRoughnessTexture|normalTexture|occlusionTexture)
"texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
MultiTextureCoordinate |
[inherits X3DTextureCoordinateNode]
MultiTextureCoordinate contains multiple TextureCoordinate or TextureCoordinateGenerator
nodes, for use by a parent polygonal geometry node such as IndexedFaceSet or a Triangle*
node. Each of the contained texture coordinate nodes correspond to the multiple texture
nodes contained in a sibling Appearance/MultiTexture node.
Hint: add Shape and then polgyonal/planar geometry before adding MultiTextureCoordinate.
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
Warning: the number of textures to be blended may have a significant impact on performance,
depending on available graphics hardware capabilities.
Hint: multitexturing is accomplished using MultiTexture, MultiTextureCoordinate and MultiTextureTransform
nodes.
Hint: X3D Texturing component Figure 18.2 Lightmap example, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#f-Lightmapexample
Hint: X3D Texturing component Table 18.2: Comparison of single texture and multitexture
attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-SingleAndMultitextureAttrs
Warning: MultiTextureCoordinate may not contain another MultiTextureCoordinate node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| texCoord |
[texCoord accessType inputOutput, type MFNode array, empty list] [X3DSingleTextureCoordinateNode]
Zero or more contained TextureCoordinate or TextureCoordinateGenerator nodes that
specify texture coordinates for the different texture channels, used for texture mapping
onto corresponding geometry.
Warning: MultiTextureCoordinate may not contain another MultiTextureCoordinate node. |
| 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 "texCoord"]
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 |
MultiTextureTransform |
[inherits X3DTextureTransformNode]
MultiTextureTransform contains multiple TextureTransform nodes, each provided for
use by corresponding ImageTexture MovieTexture or PixelTexture nodes within a sibling
MultiTexture node.
Hint: insert Shape and Appearance nodes before adding MultiTextureTransform.
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
Warning: the number of textures to be blended may have a significant impact on performance,
depending on available graphics hardware capabilities.
Hint: multitexturing is accomplished using MultiTexture, MultiTextureCoordinate and MultiTextureTransform
nodes.
Hint: X3D Texturing component Figure 18.2 Lightmap example, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#f-Lightmapexample
Hint: X3D Texturing component Table 18.2: Comparison of single texture and multitexture
attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-SingleAndMultitextureAttrs
Warning: MultiTextureTransform may not contain another MultiTextureTransform node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| textureTransform |
[textureTransform accessType inputOutput, type MFNode array, empty list] [X3DSingleTextureTransformNode]
Zero or more contained TextureTransform nodes, for each of the different texture
channels, that define 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.
Warning: MultiTextureTransform may not contain another MultiTextureTransform node. |
| 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 "textureTransform"]
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 |
NavigationInfo |
[inherits X3DBindableNode]
NavigationInfo describes the user's viewing model, user navigation-interaction modalities,
and also dimensional characteristics of the user's (typically invisible) avatar.
Hint: for inspection of simple objects, usability often improves with type="EXAMINE" "ANY"
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.
Hint: NavigationInfo types '"WALK" "FLY"' support camera-to-object collision detection.
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: Regardless of viewpoint jump value at bind time, the relative viewing transformation
between user's view and defined position/orientation is stored for later use when
un-jumping (returning to the viewpoint when subsequent viewpoint is unbound).
Hint: customizable design pattern for dedicated Viewpoint/NavigationInfo pair: <Viewpoint
DEF='SpecialView'/> <NavigationInfo DEF='SpecialNav'/> <ROUTE fromNode='SpecialView'
fromField='isBound' toNode='SpecialNav' toField='set_bind'/>
Hint: X3D Scene Authoring Hints, Viewpoints https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Viewpoints |
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. |
| type |
[type accessType inputOutput, type MFString CDATA "EXAMINE" "ANY"]
Enter one or more quoted SFString values: "EXAMINE" "WALK" "FLY" "LOOKAT" "EXPLORE"
"ANY" "NONE".
Hint: for inspection of simple objects, usability often improves with type="EXAMINE" "ANY".
Hint: types WALK and FLY force strict camera-to-object collision detection.
Hint: see Collision node for further details on camera-to-object collision detection.
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. |
| speed |
[speed accessType inputOutput, type SFFloat CDATA "1.0"] [0,+β)
Default rate at which viewer travels through scene, meters/second.
Warning: default 1 m/s usually seems slow for ordinary navigation. Interchange profile
Hint: this field may be ignored, applying the default value regardless. |
| headlight |
[headlight accessType inputOutput, type SFBool (true|false) "true"]
Enable/disable directional light that always points in the direction the user is
looking. |
| avatarSize |
[avatarSize accessType inputOutput, type MFFloat CDATA "0.25 1.6 0.75"]
avatarSize triplet values define three separate parameters: (a) collisionDistance
between user and geometry, i.e. near clipping plane of view frustrum, default 0.25m,
(b) viewer height above terrain, default 1.6m, and (c) tallest height viewer can WALK
over, default 0.75m.
Hint: X3D specification recommends that browsers set near clipping plane to one-half of
avatarSize.CollisionDistance value.
Warning: important design thumbrule is to keep (visibilityLimit / avatarSize.CollisionDistance)
< 10,000 to avoid aliasing artifacts (i.e. polygon "tearing").
Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics) Interchange profile
Hint: this field may be ignored, applying the default value regardless.
Hint: transformation hierarchy of currently bound Viewpoint node scales avatarSize, but
translations and rotations have no effect.
Hint: content must be visible to be collidable and to be pickable.
Warning: data type is MFFloat rather than SFVec3f, be sure that three values are provided
in the array since validation tools are typically unable to detect erroneous data
prior to run time. |
| visibilityLimit |
[visibilityLimit accessType inputOutput, type SFFloat CDATA "0.0"]
Geometry beyond the visibilityLimit may not be rendered (far clipping plane of the
view frustrum).
Hint: visibilityLimit=0.0 indicates an infinite visibility limit (no far clipping plane).
Hint: set visibilityLimit to appropriate positive value in meters to define far culling
plane of view frustum.
Hint: X3D specification recommends that browsers set near clipping plane to one-half of
avatarSize.CollisionDistance value.
Warning: important design thumbrule is to keep (visibilityLimit / avatarSize.CollisionDistance)
< 10,000 to avoid aliasing artifacts (i.e. polygon "tearing").
Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics) Interchange profile
Hint: this field may be ignored, applying the default value regardless. |
| transitionTime |
(X3D version 3.1 or later) [transitionTime accessType inputOutput, type MFFloat CDATA "1.0"]
transitionTime defines the expected duration of viewpoint transition in seconds.
Hint: If transitionType is "ANIMATE", transitionTime provides browser-dependent animation
parameters. Interchange profile
Hint: this field may be ignored, applying the default value regardless. |
| transitionType |
[transitionType accessType inputOutput, type MFString CDATA "LINEAR"]
Camera transition between viewpoints. Enter one or more quoted SFString values:
"ANIMATE" "TELEPORT" "LINEAR".
Hint: "ANIMATE" behavior is browser-specific, "TELEPORT" is immediate, and "LINEAR" may
proceed directly through intervening objects. |
| transitionComplete |
[transitionComplete accessType outputOnly, type MFFloat CDATA #FIXED ""]
Event signaling viewpoint transition complete. Interchange profile
Hint: this field may be ignored.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| set_bind |
[set_bind accessType inputOnly, type SFBool #FIXED ""]
Receiving event set_bind=true activates and binds this node at the top of the binding
stack. Receiving event set_bind=false deactivates and unbinds this node from the top
of the binding stack. Thus setting set_bind to true/false will enable/disable the
effect of 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 ""]
Output event true gets sent when node becomes bound and activated, otherwise output
event false gets sent when node becomes unbound and deactivated.
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 reporting timestamp 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 |
Normal |
[inherits X3DNormalNode]
Normal defines a set of 3D surface-normal vectors that apply either to a sibling
Coordinate|CoordinateDouble node, or else to a parent ElevationGrid node.
Normal values are perpendicular directions that are used per-polygon or per-vertex
when computing lighting and shading.
Hint: Normal values are typically only calculated or applied once, during initial loading
of model geometry.
Hint: custom Normal values can produce special effects.
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices.
Hint: computation of normal values is performed quite quickly on modern 3D graphics hardware,
often with no perceptible delay.
Warning: adding normal values to a model might significantly increase file size. Testing
can help determine proper tradeoffs between file size, network transmission delays
and initial rendering speed.
Hint: normal vectors perpendicular to 3D surface https://en.wikipedia.org/wiki/Normal_(geometry) |
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. |
| vector |
[vector accessType inputOutput, type MFVec3f CDATA #IMPLIED]
set of unit-length normal vectors, corresponding to indexed polygons or vertices.
Warning: unit length means a magnitude of 1.0, so normal values of (0,0,0) are invalid. |
| containerField |
[containerField type NMTOKEN (normal|skinNormal|skinBindingNormals) "normal"]
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 |
NormalInterpolator |
[inherits X3DInterpolatorNode]
NormalInterpolator generates a series of normal (perpendicular) 3-tuple SFVec3f
values. Each vector value has unit length, i.e. the set of allowed vectors describes
the surface of a unit sphere. Authors can ROUTE value_changed output events to a Normal
node's vector field, or to another 3-tuple SFVec3f field.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
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 MFVec3f CDATA #IMPLIED]
Output values for linear interpolation, each corresponding to an input-fraction
value in the key array.
Hint: identical adjacent entries in keyValue array have the effect of defining constant-value
step functions. https://en.wikipedia.org/wiki/Step_function
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 MFVec3f CDATA #FIXED ""]
Linearly interpolated output value determined by current key time and corresponding
keyValue pair.
Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive
superfluous events that have no effect.
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 |
|
NurbsCurve |
[inherits X3DParametricGeometryNode]
NurbsCurve is a 3D curve analogous to NurbsPatchSurface.
Hint: the contained controlPoint field can hold a Coordinate or CoordinateDouble node.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| controlPoint |
[controlPoint accessType inputOutput, type SFNode singleton, NULL node] [Coordinate | CoordinateDouble | GeoCoordinate]
Single contained Coordinate or CoordinateDouble node that can specify control points
for NURBS geometry definitions. |
| 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. |
| knot |
[knot accessType initializeOnly, type MFDouble CDATA #IMPLIED]
knot vector, where size = number of control points + order of curve. |
| order |
[order accessType initializeOnly, type SFInt32 CDATA "3"]
define order of surface by polynomials of degree = order-1. |
| weight |
[weight accessType inputOutput, type MFDouble CDATA #IMPLIED]
Vector assigning relative weight value to each control point. |
| tessellation |
[tessellation accessType inputOutput, type SFInt32 CDATA #IMPLIED]
hint for surface tessellation. |
| closed |
[closed accessType initializeOnly, type SFBool (true|false) "false"]
Whether or not the curve is closed (i.e. matching end values). |
| containerField |
[containerField type NMTOKEN "geometry"]
geometry is the field-label prefix indicating relationship to parent node. Example
values: 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 |
|
NurbsCurve2D |
[inherits X3DNurbsControlCurveNode]
NurbsCurve2D defines a trimming segment that is part of a trimming contour in the
u-v domain of a surface. NurbsCurve2D and ContourPolyline2D nodes that together form
a closed contour, defined in the u-v parametric space of a NURBS surface, may be used
as children in a Contour2D node.
Warning: NurbsCurve2D is not a renderable geometry node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| controlPoint |
[controlPoint accessType inputOutput, type MFVec2f CDATA #IMPLIED]
controlPoint defines a set of control points of dimension uDimension by vDimension,
and defines a mesh where the points do not have uniform spacing. |
| knot |
[knot accessType initializeOnly, type MFDouble CDATA #IMPLIED]
knot vector, where size = number of control points + order of curve. |
| order |
[order accessType initializeOnly, type SFInt32 CDATA "2"]
define order of surface by polynomials of degree = order-1. |
| weight |
[weight accessType inputOutput, type MFDouble CDATA #IMPLIED]
Vector assigning relative weight value to each control point. |
| tessellation |
[tessellation accessType inputOutput, type SFInt32 CDATA "0"]
hint for surface tessellation. |
| closed |
[closed accessType initializeOnly, type SFBool (true|false) "false"]
Whether or not the curve is closed (i.e. matching end values). |
| 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 |
NurbsOrientationInterpolator |
[inherits X3DChildNode]
NurbsOrientationInterpolator describes a 3D NURBS curve and outputs interpolated
orientation values.
Hint: the SFNode controlPoint field can contain a single Coordinate or CoordinateDouble
node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| controlPoint |
[controlPoint accessType inputOutput, type SFNode singleton, NULL node] [Coordinate | CoordinateDouble | GeoCoordinate]
Single contained Coordinate or CoordinateDouble node that can specify control points
for NURBS geometry definitions. |
| 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. |
| knot |
[knot accessType inputOutput, type MFDouble CDATA #IMPLIED]
knot vector, where size = number of control points + order of curve. |
| order |
[order accessType inputOutput, type SFInt32 CDATA "3"]
define order of surface by polynomials of degree = order-1. |
| weight |
[weight accessType inputOutput, type MFDouble CDATA #IMPLIED]
Output values for computational interpolation, each corresponding to knots.
Hint: number of weights must match number of knots! |
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
setting fraction in range [0,1] selects input key for corresponding keyValue output,
computing a 3D position on the curve.
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 SFRotation CDATA #FIXED ""]
Computationaly interpolated output value determined by current key time and corresponding
keyValue pair.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
NurbsPatchSurface |
[inherits X3DNurbsSurfaceGeometryNode]
NurbsPatchSurface defines a contiguous 3D Non-Uniform Rational B-Spline (NURBS)
surface. |
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 |
| controlPoint |
[controlPoint accessType inputOutput, type SFNode singleton, NULL node] [Coordinate | CoordinateDouble | GeoCoordinate]
Single contained Coordinate or CoordinateDouble node that can specify control points
for NURBS geometry definitions. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode | NurbsTextureCoordinate]
Single contained NurbsTextureCoordinate, TextureCoordinate, TextureCoordinateGenerator
or MultiTextureCoordinate node that can specify coordinates for texture mapping onto
corresponding geometry. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| uClosed |
[uClosed accessType initializeOnly, type SFBool (true|false) "false"]
Whether opposite surface sides are closed (seamless) across u dimension. |
| vClosed |
[vClosed accessType initializeOnly, type SFBool (true|false) "false"]
Whether opposite surface sides are closed (seamless) across u dimension. |
| uDimension |
[uDimension accessType initializeOnly, type SFInt32 CDATA "0"]
Number of control points in u dimension. |
| vDimension |
[vDimension accessType initializeOnly, type SFInt32 CDATA "0"]
Number of control points in v dimension. |
| uKnot |
[uKnot accessType initializeOnly, type MFDouble CDATA #IMPLIED]
knot vector, where size = number of control points + order of curve. |
| vKnot |
[vKnot accessType initializeOnly, type MFDouble CDATA #IMPLIED]
knot vector, where size = number of control points + order of curve. |
| uOrder |
[uOrder accessType initializeOnly, type SFInt32 CDATA "3"]
define order of surface by polynomials of degree = order-1. |
| vOrder |
[vOrder accessType initializeOnly, type SFInt32 CDATA "3"]
define order of surface by polynomials of degree = order-1. |
| uTessellation |
[uTessellation accessType inputOutput, type SFInt32 CDATA "0"]
hint for surface tessellation. |
| vTessellation |
[vTessellation accessType inputOutput, type SFInt32 CDATA "0"]
hint for surface tessellation. |
| weight |
[weight accessType inputOutput, type MFDouble CDATA #IMPLIED]
Vector assigning relative weight value to each control point. |
| 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.
Hint: accessType relaxed to inputOutput in order to support animation and visualization.
|
| containerField |
[containerField type NMTOKEN "surface"]
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 |
NurbsPositionInterpolator |
[inherits X3DChildNode]
NurbsPositionInterpolator describes a 3D NURBS curve and outputs interpolated position
values.
Hint: the SFNode controlPoint field can contain a single Coordinate or CoordinateDouble
node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| controlPoint |
[controlPoint accessType inputOutput, type SFNode singleton, NULL node] [Coordinate | CoordinateDouble | GeoCoordinate]
Single contained Coordinate or CoordinateDouble node that can specify control points
for NURBS geometry definitions. |
| 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. |
| knot |
[knot accessType inputOutput, type MFDouble CDATA #IMPLIED]
knot vector, where size = number of control points + order of curve. |
| order |
[order accessType inputOutput, type SFInt32 CDATA "3"]
define order of surface by polynomials of degree = order-1. |
| weight |
[weight accessType inputOutput, type MFDouble CDATA #IMPLIED]
Output values for linear interpolation, each corresponding to knots.
Hint: number of weights must match number of knots! |
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
setting fraction in range [0,1] selects input key for corresponding keyValue output,
computing a 3D position on the curve.
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 SFVec3f CDATA #FIXED ""]
Computationaly interpolated output value determined by current key time and corresponding
keyValue pair.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
NurbsSet |
[inherits X3DChildNode, implements X3DBoundedObject]
NurbsSet collects a set of NurbsSurface nodes into a common group and treats NurbsSurface
set as a unit during tessellation, thereby enforcing tessellation continuity along
borders.
Warning: geometry represented in children of this node shall not be directly rendered. It
is an informational node only.
Warning: Surfaces not represented elsewhere in transformation hierarchy shall not be rendered.
Hint: USE nodes for geometry ensure renderable versions occur elsewhere in the model.
The bounds information is provided for optimization purposes only. A browser may choose
to use this information about when to apply trimming or smooth tessellation between
patches based on the bounds information. |
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 |
| geometry |
[geometry accessType inputOutput, type MFNode array, empty list] [NurbsPatchSurface | NurbsTrimmedSurface]
The children form a closed loop with first point of first child repeated as last
point of last child, and the last point of a segment repeated as first point of the
consecutive one.
Hint: children nodes are listed in consecutive order according to topology of the contour.
Warning: geometry represented in children of this node shall not be directly rendered. It
is an informational node only.
Warning: Surfaces not represented elsewhere in transformation hierarchy shall not be rendered.
Hint: utilizing USE nodes for geometry can ensure that rendered geometry occurs elsewhere
in the model. |
| 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. |
| tessellationScale |
[tessellationScale accessType inputOutput, type SFFloat CDATA "1"]
scale for surface tessellation in children NurbsSurface nodes. |
| 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 |
NurbsSurfaceInterpolator |
[inherits X3DChildNode]
NurbsSurfaceInterpolator describes a 3D NURBS curve and outputs interpolated position
and normal values.
Hint: the SFNode controlPoint field can contain a single Coordinate or CoordinateDouble
node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| controlPoint |
[controlPoint accessType inputOutput, type SFNode singleton, NULL node] [Coordinate | CoordinateDouble | GeoCoordinate]
Single contained Coordinate or CoordinateDouble node that can specify control points
for NURBS geometry definitions. |
| 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. |
| uDimension |
[uDimension accessType initializeOnly, type SFInt32 CDATA "0"]
Number of control points in u dimension. |
| vDimension |
[vDimension accessType initializeOnly, type SFInt32 CDATA "0"]
Number of control points in v dimension. |
| uKnot |
[uKnot accessType initializeOnly, type MFDouble CDATA #IMPLIED]
Knot vector, where size = number of control points + order of curve. |
| vKnot |
[vKnot accessType initializeOnly, type MFDouble CDATA #IMPLIED]
Knot vector, where size = number of control points + order of curve. |
| uOrder |
[uOrder accessType initializeOnly, type SFInt32 CDATA "3"]
Define order of surface by polynomials of degree = order-1. |
| vOrder |
[vOrder accessType initializeOnly, type SFInt32 CDATA "3"]
Define order of surface by polynomials of degree = order-1. |
| weight |
[weight accessType inputOutput, type MFDouble CDATA #IMPLIED]
Output values for linear interpolation, each corresponding to knots.
Hint: number of weights must match number of knots! |
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
setting fraction in range [0,1] selects input key for corresponding keyValue output,
computing a 3D position on the curve.
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. |
| normal_changed |
[normal_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
Computationaly interpolated output value determined by current key time and corresponding
keyValue pair.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| position_changed |
[position_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
Computationaly interpolated output value determined by current key time and corresponding
keyValue pair.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
NurbsSweptSurface |
[inherits X3DParametricGeometryNode]
NurbsSweptSurface uses a trajectoryCurve path to describe a generalized surface
that is swept by a crossSectionCurve.
Hint: conceptually it is the NURBS equivalent of Extrusion but permits the use of non-closed
cross sections. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| crossSectionCurve |
[crossSectionCurve accessType inputOutput, type SFNode singleton, NULL node] [X3DNurbsControlCurveNode]
defines cross-section of the surface traced about the trajectoryCurve axis. |
| 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 |
| trajectoryCurve |
[trajectoryCurve accessType inputOutput, type SFNode singleton, NULL node] [NurbsCurve]
describes the center-line path using a NurbsCurve node, oriented so that it is defined
counterclockwise when looking down the βY axis, thus defining a concept of inside
and outside. |
| 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. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| 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.
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 |
|
NurbsSwungSurface |
[inherits X3DNurbsControlCurveNode]
NurbsSwungSurface contains a profileCurve and a trajectoryCurve [X3DNurbsControlCurveNode].
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| profileCurve |
[profileCurve accessType inputOutput, type SFNode singleton, NULL node] [X3DNurbsControlCurveNode]
2D curve in the yz-plane that describes the cross-sectional shape of the object.
|
| 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 |
| trajectoryCurve |
[trajectoryCurve accessType inputOutput, type SFNode singleton, NULL node] [X3DNurbsControlCurveNode]
2D curve in the xz-plane that describes path over which to trace the cross-section.
|
| 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. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| 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.
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 |
NurbsTextureCoordinate |
[inherits X3DNode]
NurbsTextureCoordinate describes a 3D NURBS surface
in the parametric domain of its surface host, specifying mapping of texture onto the
surface.
Hint: the SFNode controlPoint field can contain a single Coordinate or CoordinateDouble
node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| uDimension |
[uDimension accessType initializeOnly, type SFInt32 CDATA "0"]
Number of control points in u dimension. |
| vDimension |
[vDimension accessType initializeOnly, type SFInt32 CDATA "0"]
Number of control points in v dimension. |
| uKnot |
[uKnot accessType initializeOnly, type MFDouble CDATA #IMPLIED]
Knot vector, where size = number of control points + order of curve. |
| vKnot |
[vKnot accessType initializeOnly, type MFDouble CDATA #IMPLIED]
Knot vector, where size = number of control points + order of curve. |
| uOrder |
[uOrder accessType initializeOnly, type SFInt32 CDATA "3"]
Define order of surface by polynomials of degree = order-1. |
| vOrder |
[vOrder accessType initializeOnly, type SFInt32 CDATA "3"]
Define order of surface by polynomials of degree = order-1. |
| controlPoint |
[controlPoint accessType inputOutput, type MFVec2f CDATA #IMPLIED]
controlPoint defines a set of control points of dimension uDimension by vDimension,
and defines a mesh where the points do not have uniform spacing. |
| weight |
[weight accessType inputOutput, type MFFloat CDATA #IMPLIED]
Output values for linear interpolation, each corresponding to knots.
Hint: number of weights must match number of knots! |
| containerField |
[containerField type NMTOKEN "texCoord"]
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 |
NurbsTrimmedSurface |
[inherits X3DNurbsSurfaceGeometryNode]
NurbsTrimmedSurface generates texture coordinates from a Non-Uniform Rational B-Spline
(NURBS) surface. |
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 |
| controlPoint |
[controlPoint accessType inputOutput, type SFNode singleton, NULL node] [Coordinate | CoordinateDouble | GeoCoordinate]
Single contained Coordinate or CoordinateDouble node that can specify control points
for NURBS geometry definitions. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode | NurbsTextureCoordinate]
Single contained NurbsTextureCoordinate, TextureCoordinate, TextureCoordinateGenerator
or MultiTextureCoordinate node that can specify coordinates for texture mapping onto
corresponding geometry. |
| trimmingContour |
[trimmingContour accessType inputOutput, type MFNode array, empty list] [Contour2D]
A set of Contour2D nodes are used as trimming loops.
Hint: if no trimming contours are defined, NurbsTrimmedSurface has same semantics as NurbsPatchSurface
node. |
| 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. |
| uClosed |
[uClosed accessType initializeOnly, type SFBool (true|false) "false"]
Whether opposite surface sides are closed (seamless) across u dimension. |
| vClosed |
[vClosed accessType initializeOnly, type SFBool (true|false) "false"]
Whether opposite surface sides are closed (seamless) across u dimension. |
| uDimension |
[uDimension accessType initializeOnly, type SFInt32 CDATA "0"]
Number of control points in u dimension. |
| vDimension |
[vDimension accessType initializeOnly, type SFInt32 CDATA "0"]
Number of control points in v dimension. |
| uKnot |
[uKnot accessType initializeOnly, type MFDouble CDATA #IMPLIED]
Knot vector, where size = number of control points + order of curve. |
| vKnot |
[vKnot accessType initializeOnly, type MFDouble CDATA #IMPLIED]
Knot vector, where size = number of control points + order of curve. |
| uOrder |
[uOrder accessType initializeOnly, type SFInt32 CDATA "3"]
Define order of surface by polynomials of degree = order-1. |
| vOrder |
[vOrder accessType initializeOnly, type SFInt32 CDATA "3"]
Define order of surface by polynomials of degree = order-1. |
| uTessellation |
[uTessellation accessType inputOutput, type SFInt32 CDATA "0"]
hint for surface tessellation. |
| vTessellation |
[vTessellation accessType inputOutput, type SFInt32 CDATA "0"]
hint for surface tessellation. |
| weight |
[weight accessType inputOutput, type MFDouble CDATA #IMPLIED]
Vector assigning relative weight value to each control point. |
| 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.
Hint: accessType relaxed to inputOutput in order to support animation and visualization.
|
| containerField |
[containerField type NMTOKEN "texCoord"]
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 |
OpacityMapVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
OpacityMapVolumeStyle specifies that volumetric data is rendered using opacity mapped
to a transfer function texture.
Hint: contains a single ImageTexture2D or ImageTexture3D node with containerField='transferFunction'.
Voxel values are used as lookup coordinates into the transfer function texture, where
the texel value represents the output color.
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 |
| transferFunction |
[transferFunction accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode,X3DTexture3DNode]
The transferFunction field holds a single texture representation in either two or
three dimensions that maps the voxel data values to a specific colour output. If no
value is supplied for this field, the default implementation shall generate a 256x1
alpha-only image that blends from completely transparent at pixel 0 to fully opaque
at pixel 255.The texture may be any number of dimensions and any number of components.
The voxel values are used as a lookup coordinates into the transfer function texture,
where the texel value represents the output colour. |
| 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. |
| 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 |
OrientationChaser |
(X3D version 3.2 or later) [inherits X3DChaserNode]
OrientationChaser generates a series of 4-tuple axis-angle SFRotation values that
progressively change from initial value to destination value.
Hint: ROUTE value_changed output events to a <Transform> node's rotation field, for example.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 SFRotation CDATA "0 1 0 0"]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type SFRotation CDATA "0 1 0 0"]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type SFRotation 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 SFRotation 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 SFRotation 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 |
|
OrientationDamper |
(X3D version 3.2 or later) [inherits X3DDamperNode]
OrientationDamper generates a series of 4-tuple axis-angle SFRotation values that
progressively change from initial value to destination value.
Hint: ROUTE value_changed output events to a <Transform> node's rotation field, for example.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 SFRotation CDATA "0 0 0"]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type SFRotation CDATA "0 0 0"]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type SFRotation 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 SFRotation 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 SFRotation 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 |
OrientationInterpolator |
[inherits X3DInterpolatorNode]
OrientationInterpolator generates a series of 4-tuple axis-angle SFRotation values.
Authors can ROUTE value_changed output events to a Transform node's rotation field
or to another 4-tuple SFRotation field.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
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 MFRotation 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 SFRotation 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 |
OrthoViewpoint |
[inherits X3DViewpointNode]
OrthoViewpoint provides an orthographic perspective-free view of a scene from a
specific location and direction.
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.
Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more
than one of these nodes can be bound and 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.
Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch,
instead use ViewpointGroup as parent to constrain location proximity where the viewpoint
is available to user.
Hint: Regardless of viewpoint jump value at bind time, the relative viewing transformation
between user's view and defined position/orientation is stored for later use when
un-jumping (returning to the viewpoint when subsequent viewpoint is unbound).
Hint: customizable design pattern for dedicated Viewpoint/NavigationInfo pair: <Viewpoint
DEF='SpecialView'/> <NavigationInfo DEF='SpecialNav'/> <ROUTE fromNode='SpecialView'
fromField='isBound' toNode='SpecialNav' toField='set_bind'/>
Hint: X3D Scene Authoring Hints, Viewpoints https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Viewpoints |
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 |
| navigationInfo |
[navigationInfo accessType inputOutput, type SFNode singleton, NULL node] [NavigationInfo]
The navigationInfo field defines a dedicated NavigationInfo node for this X3DViewpointNode.
The specified NavigationInfo node receives a set_bind TRUE event at the time when
the parent node is bound and receives a set_bind FALSE at the time when the parent
node is unbound.
Hint: allows simple integration of custom navigation associated with each Viewpoint according
to user needs at that location. |
| viewAll |
[viewAll accessType inputOutput, type SFBool (true|false), false]
Viewpoint is automatically adjusted to view all visible geometry. Typically centerOfRotation
is shifted to center of current bounding box and view is zoomed in or out until all
visible objects are viewed.
Hint: no collision detection or proximity sensing occurs when zooming.
Warning: if needed, near and far clipping planes shall be adjusted to allow viewing the entire
scene.
Hint: when the value of the viewAll field is changed from TRUE to FALSE, no change in
the current view occurs. |
| 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 initializeOnly, type SFString CDATA #IMPLIED]
Text description or navigation hint to describe the significance of this model Viewpoint.
Hint: a sequence of good Viewpoints with understandable descriptions can provide a guided
tour of a model.
Hint: the currently bound NavigationInfo node has a major effect on how a user might change
viewing position and orientation after reaching this Viewpoint.
Hint: consider paired Viewpoint/NavigationInfo node combinations by defining ROUTE connections
between corresponding isBound/set_bind fields.
Hint: include space characters since a description is not a DEF identifier. Write short
phrases that make descriptions clear and readable.
Warning: without description, this OrthoViewpoint is unlikely to appear on browser Viewpoint
menus.
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). |
| farDistance |
[farDistance accessType inputOutput, type SFFloat CDATA "-1"] or (0,+β)
farDistance defines maximum clipping plane distance allowed for object display.
Hint: overrides bound NavigationInfo visibilityLimit value, if any.
Hint: default value -1 means no effect on currently defined view frustum boundaries.
Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
Warning: nearDistance must be less than farDistance. |
| nearDistance |
[nearDistance accessType inputOutput, type SFFloat CDATA "-1"] or (0,+β)
nearDistance defines minimum clipping plane distance necessary for object display.
Hint: overrides bound NavigationInfo avatarSize value, if any.
Hint: default value -1 means no effect on currently defined view frustum boundaries.
Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
Warning: nearDistance must be less than farDistance. |
| position |
[position accessType inputOutput, type SFVec3f CDATA "0 0 10"]
position (x, y, z in meters) relative to local coordinate system. |
| orientation |
[orientation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Rotation (axis, angle in radians) of Viewpoint, relative to default -Z axis direction
in local coordinate system.
Warning: for VR/AR/MR/XR users wearing a head-mounted display (HMD), animating this field
may induce motion sickness.
Hint: this is orientation _change_ from default direction (0 0 -1) along the -X axis.
Hint: complex rotations can be accomplished axis-by-axis using parent Transforms. |
| centerOfRotation |
[centerOfRotation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
centerOfRotation specifies center point about which to rotate user's eyepoint when
in EXAMINE or LOOKAT mode. |
| fieldOfView |
[fieldOfView accessType inputOutput, type MFFloat CDATA "-1 -1, 1 1"]
Minimum and maximum extents of view in units of local coordinate system. Small field
of view roughly corresponds to a telephoto lens, large field of view roughly corresponds
to a wide-angle lens.
Hint: validation type SFVec3f is stricter than specification legacy value in order to
detect illegal values.
Warning: minimum corner values must remain less than maximum corner values.
Hint: rectangular display width/height = (maxX-minX) / (maxY-minY)
Warning: OrthoViewpoint fieldOfView has type MFFloat even though SFVec3f is more correct
to prevent modeling errors, deficiency recorded as Mantis 1398 |
| jump |
[jump accessType inputOutput, type SFBool (true|false) "true"]
Transition instantly by jumping, otherwise smoothly adjust offsets in place when
changing to this Viewpoint.
Hint: see NavigationInfo.transitionType for the manner in which animated Viewpoint transistions
occur.
Hint: set jump=true for instantaneous camera motion when going to this viewpoint.
Warning: for VR/AR/MR/XR users wearing head-mounted displays, animating transitions between
viewpoints may induce motion sickness. |
| retainUserOffsets |
[retainUserOffsets accessType inputOutput, type SFBool (true|false) "false"]
Retain (true) or reset to zero (false) any prior user navigation offsets from defined
viewpoint position, orientation. |
| set_bind |
[set_bind accessType inputOnly, type SFBool #FIXED ""]
Sending event set_bind=true makes this node active. Sending event set_bind=false
makes this node inactive. Thus setting set_bind to true/false will pop/push (enable/disable)
this Viewpoint.
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 ""]
Output event true gets sent when node becomes bound and activated, otherwise output
event false gets sent when node becomes unbound and deactivated.
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 reporting timestamp 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 |
|
OscillatorSource |
[inherits X3DSoundSourceNode]
OscillatorSource node represents an audio source generating a periodic waveform,
providing a constant tone.#10;
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#oscillatornode |
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 |
| periodicWave |
[periodicWave accessType inputOutput, type SFNode singleton, NULL node] [PeriodicWave]
The periodicWave field is an optional PeriodicWave node providing a regular or arbitrary
periodic waveform.
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 ffield is an a-rate AudioParam representing detuning of oscillation in
cents (though the AudioParam returned is read-only, the value it represents is not).
|
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| frequency |
[frequency accessType inputOutput, type SFFloat CDATA "440.0"]
The frequency of oscillation in hertz. The default value 440 Hz is a standard middle-A
note. |
| 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 |
| 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 |
|
PackagedShader |
(X3D version 3.1 or later) [inherits X3DShaderNode, implements X3DUrlObject, X3DProgrammableShaderObject]
PackagedShader contains a url for a single file that may contain a number of shaders
and combined effects.
Hint: PackagedShader contains field declarations and then corresponding IS/connect statements
(if any).
Warning: PackagedShader does not contain CDATA section of plain-text source code.
Hint: apply default containerField='shaders' when parent node is 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 |
| field |
[X3D statement field]
Include a field statement for each field declaration in the PackagedShader node.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| activate |
[activate accessType inputOnly, type SFBool (true|false)]
activate forces the shader to activate the contained objects.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| isSelected |
[isSelected accessType outputOnly, type SFBool (true|false)]
isSelected indicates this shader instance is selected for use by browser
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isValid |
[isValid accessType outputOnly, type SFBool (true|false)]
isValid indicates whether current shader objects can be run as a shader program.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| language |
[language accessType initializeOnly, type SFString CDATA #IMPLIED]
The language field indicates to the X3D player which shading language is used. The
language field may be used to optionally determine the language type if no MIME-type
information is available.
Hint: recognized values include "Cg" "GLSL" "HLSL". |
| 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). |
| 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. |
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
url points to a shader source-code file that may contain a number of shaders and
combined effects.
Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls |
| containerField |
[containerField type NMTOKEN (shaders|watchList) "shaders"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
ParticleSystem |
(X3D version 3.2 or later) [inherits X3DShapeNode]
ParticleSystem specifies a complete particle system. It can contain Appearance for
particle appearance, a geometry node if gemoetryType='GEOMETRY', a color field with
Color|ColorRGBA node for changing base color over each particle's lifetime, a texcoord
TextureCoordinate node to control texture coordinates of provided texture(s) in the
Appearance node over time, a single emitter X3DParticleEmitterNode, and an array of
physics X3DParticlePhysicsModelNode nodes.
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: Wikipedia, particle system https://en.wikipedia.org/wiki/Particle_system |
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. |
| appearance |
[appearance accessType inputOutput, type SFNode singleton, NULL node] [X3DAppearanceNode]
The appearance field holds an Appearance node that is used for the geometry. All
effects, such as material colors and/or multi-textures, are applied to each particle.
Hint: if a texture coordinate ramp and key is supplied with this geometry, it shall be
used in preference to any automatic texture coordinate generation.
Hint: if automatic texture coordinate generation is used, results shall be based on the
entire volume that the particles consume, not locally applied to each particle. |
| 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.
|
| castShadow |
[castShadow accessType inputOutput, type SFBool (true|false) "true"]
The castShadow field defines whether this Shape casts shadows as produced by lighting
nodes.
Hint: if the visible field is FALSE, then the Shape does not cast any shadows, regardless
of the castShadow value.
Hint: if prior X3D3 content is loaded into an X3D4 model, then legacy Shape nodes have
shadows set to true. |
| colorKey |
[colorKey accessType initializeOnly, type MFFloat CDATA #IMPLIED] [0,+β)
Array of time intervals in seconds, corresponding to particle lifetime, that are
used to interpolate color array values.
Hint: color values are interpolated in linear Hue Saturation Value (HSV) space, similar
to ColorInterpolator node.
Hint: color values are defined as per-vertex color values.
Warning: if an Appearance and Material nodes are provided, those material properties override
color field interpolation.
Hint: number of colorKey values must match length of the per-vertex color field array
values!
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| color |
[color accessType initializeOnly, type SFNode singleton, NULL node] [X3DColorNode]
The color field contains Color|ColorRGBA nodes as a series of color values to be
used at the given colorKey points in time.
Warning: field originally named 'colorRamp' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
Hint: color values are defined as per-vertex color values.
Warning: if an Appearance and Material nodes are provided, those material properties override
color field interpolation.
Hint: number of colorKey values must match length of the per-vertex color field array
values!
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| createParticles |
[createParticles accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables creation of new particles, while any existing particles remain
in existence and continue to animate until the end of their lifetimes.
Hint: if no particles are left in scene, system is considered both active and enabled.
|
| emitter |
[emitter accessType initializeOnly, type SFNode singleton, NULL node] [X3DParticleEmitterNode]
The emitter field specifies the type of emitter geometry and properties that the
particles are given for their initial positions. |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| geometryType |
[geometryType accessType initializeOnly, type SFString CDATA ( LINE|POINT|QUAD|SPRITE|TRIANGLE|GEOMETRY ) QUAD]
specifies type of geometry used to represent individual particles. Typically, a
particle is calculated as point in space at which the geometry is placed. Changing
the value of the geometry field or the definition of the geometry node shall be applied
during current computation of the next frame to be rendered.
Hint: LINE means that a line is drawn along the particle's current velocity vector, for
this frame, centered about the particle's position. The length of the line is specified
by the particle's height from the particleSize field value.
Hint: POINT means that a point geometry is rendered at the particle's position.
Hint: QUAD means that a 2D quad is rendered aligned in the local coordinate space of the
particle system with the face normal pointing along the positive Z axis. Individual
quads are not aligned to the user's eye position but are affected in depth by the
physics model. The particle's position is at the center of the quad.
Hint: SPRITE means that a point sprite that uses a 2D point position to locate a screen-aligned
quad at the center of the particle's location is rendered.
Hint: TRIANGLE means that a 2D quad is rendered using a pair of triangles aligned in the
local coordinate space of the particle system with the face normal pointing along
the positive Z axis. Individual triangles are not aligned to the user's eye position,
but are affected in depth by the physics model. The particle's position is at the
center of the triangle.
Hint: GEOMETRY means that the geometry specified by the geometry field is rendered for
each particle using the local coordinate system.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values.
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'/>
|
| geometry |
[geometry accessType inputOutput, type SFNode singleton, NULL node] [X3DGeometryNode]
Single contained geometry node provides geometry used for each particle when 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'/>
|
| physics |
[physics accessType initializeOnly, type MFNode array, empty list] [X3DParticlePhysicsModelNode]
After being created, the individual particles are then manipulated according to
the physics model(s) specified in the physics field. |
| lifetimeVariation |
[lifetimeVariation accessType inputOutput, type SFFloat CDATA "0.25"] [0,1)
TODO not properly defined in X3D spedification. Multiplier for the randomness used
to control the range of possible output values. The bigger the value, the more random
the output and the bigger the range of initial values possible.
Hint: variation of zero does not allow any randomness. |
| maxParticles |
[maxParticles accessType inputOutput, type SFInt32 CDATA "200"] [0,+β)
Maximum number of particles to be generated at one time (subject to player limitations).
|
| particleLifetime |
[particleLifetime accessType inputOutput, type SFFloat CDATA "5"] [0,+β)
TODO not properly defined in X3D spedification. Particle animation lifetime in base
time units (default is seconds). |
| particleSize |
[particleSize accessType inputOutput, type SFVec2f CDATA "0.02 0.02"] [0,+β)
particleSize describes width and height dimensions for each particle in length base
units (default is meters). Changing this value dynamically will only change new particles
created after the change.
Hint: particles created before this timestamp will remain at the old size.
Hint: his field only effects particles using LINE, QUAD, SPRITE, and TRIANGLE geometry
types. |
| 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. |
| texCoordKey |
[texCoordKey accessType initializeOnly, type MFFloat CDATA #IMPLIED] [0,+β)
Array of time intervals in seconds, corresponding to particle lifetime, that are
used to sequence texCoord array values.
Hint: no interpolation is performed, texture coordinates are simply sequenced in order.
Hint: texture-coordinate values map textures to vertices in the geometry.
Hint: number of texCoordKey values must match length of the per-vertex texCoord arrays!
|
| texCoord |
[texCoord accessType initializeOnly, type SFNode singleton, NULL node] [TextureCoordinate | TextureCoordinateGenerator]
texture coordinates of the provided texture(s) in the Appearance node, over time.
Particle systems frequently like to change the texture on a particle as it ages, yet
there is no good way of accomplishing this through standard interpolators because
interpolators have no concept of particle time. This pair of fields hold time-dependent
values for the texture coordinates to be applied to the particle. When a particle
reaches the next time stamp it moves to the next set of texture coordinates.
Warning: field originally named 'texCoordRamp' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
Hint: texture-coordinate values map textures to vertices in the geometry.
Hint: number of texCoordKey values must match length of the per-vertex texCoord arrays!
|
| 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. |
| 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 |
| 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 |
|
PeriodicWave |
[inherits X3DNode]
PeriodicWave defines a periodic waveform that can be used to shape the output of
an Oscillator.#10;
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#periodicwave |
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. |
| 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. |
| optionsReal |
[optionsReal accessType inputOutput, type MFFloat CDATA ""]
real coefficients for defining a waveform.
Warning: array lengths for optionsReal and optionsImag must match. |
| optionsImag |
[optionsImag accessType inputOutput, type MFFloat CDATA ""]
imaginary coefficients for defining a waveform.
Warning: array lengths for optionsReal and optionsImag must match. |
| type |
[type accessType inputOutput, type SFString CDATA ( SINE|SQUARE|SAWTOOTH|TRIANGLE|CUSTOM ) SQUARE]
The type field specifies shape of waveform to play, which can be one of several
provided values or else 'custom' to indicate that real and imaginary coefficient arrays
define a custom waveform.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dictdef-periodicwaveoptions |
| containerField |
[containerField type NMTOKEN "periodicWave"]
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 |
|
PhysicalMaterial |
[inherits X3DOneSidedMaterialNode]
PhysicalMaterial specifies surface rendering properties for associated geometry
nodes.
Material attributes are used by the X3D lighting equations during rendering.
Hint: insert Shape and Appearance nodes before adding material.
Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related
shapes in a scene.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
Hint: X3D Example Archives, Basic, Universal Media Materials https://www.web3d.org/x3d/content/examples/Basic/UniversalMediaMaterials
Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/lighting.html#Lightingmodel
Hint: Rendering https://en.wikipedia.org/wiki/Rendering_(computer_graphics)
Hint: 3D rendering https://en.wikipedia.org/wiki/3D_rendering
Hint: Physically based rendering (PBR) https://en.wikipedia.org/wiki/Physically_based_rendering |
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. |
| baseColor |
[baseColor accessType inputOutput, type SFColor CDATA "1 1 1"] [0,1]
similar to diffuseColor, TODO define more precisely. |
| baseTexture |
[baseTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying baseColor for this material node, the contained texture provides Physically
Based Rendering (PBR) modulation for each pixel.
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='baseTexture' |
| baseTextureMapping |
[baseTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| emissiveColor |
[emissiveColor accessType inputOutput, type SFColor CDATA "0 0 0"] [0,1]
how much glowing light is emitted from this object.
Hint: emissiveColors glow even when all lights are off.
Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
Warning: bright emissiveColor values can wash out other colors and some textures. |
| emissiveTexture |
[emissiveTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying emissiveColor for this material node, the contained texture provides
Physically Based Rendering (PBR) modulation for each pixel.
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='emissiveTexture' |
| emissiveTextureMapping |
[emissiveTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| metallic |
[metallic accessType inputOutput, type SFFloat CDATA "1"] [0,1]
metallic is a PBR parameter (TODO elaborate) |
| metallicRoughnessTexture |
[metallicRoughnessTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying metallic for this material node, the contained texture provides Physically
Based Rendering (PBR) modulation for each pixel.
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='metallicRoughnessTexture' |
| metallicRoughnessTextureMapping |
[metallicRoughnessTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| normalScale |
[normalScale accessType inputOutput, type SFFloat CDATA "1"] [0,β]
normalScale controls the degree to which normalTexture RGB values apply XYZ-normal
bump mapping to pixels in the parent material.
Hint: normalScale only affects computation of normalTexture modulations that affect lighting
of characteristics of the parent Material and has no relation to normal vectors defined
by corresponding geometry.
Hint: normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping |
| normalTexture |
[normalTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying normalScale for this material node, the contained texture modulates
the texture across the surface.
Hint: normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='normalTexture' |
| normalTextureMapping |
[normalTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| occlusionStrength |
[occlusionStrength accessType inputOutput, type SFFloat CDATA "1"] [0,1]
occlusionStrength indicates areas of indirect lighting, typically called ambient
occlusion. Higher values indicate areas that should receive full indirect lighting
and lower values indicate no indirect lighting.
Hint: only the Red channel of the texture is used for occlusion computations, other channels
are ignored.
Hint: https://en.wikipedia.org/wiki/Ambient_occlusion |
| occlusionTexture |
[occlusionTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying occlusionStrength for this material node, the contained texture provides
Physically Based Rendering (PBR) modulation for each pixel.
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='occlusionTexture' |
| occlusionTextureMapping |
[occlusionTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| roughness |
[roughness accessType inputOutput, type SFFloat CDATA "1"] [0,1]
roughness is a PBR parameter (TODO elaborate) |
| transparency |
[transparency accessType inputOutput, type SFFloat CDATA "0"] [0,1]
how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque.
Interchange profile
Hint: transparency < .5 opaque, transparency > .5 transparent. |
| containerField |
[containerField type NMTOKEN "material"]
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 |
|
PickableGroup |
(X3D version 3.2 or later) [inherits X3DGroupingNode, implements X3DPickableObject, X3DVisibleObject]
PickableGroup is a Grouping node that can contain most nodes. PickableGroup contains
children that are marked as having a given classification of picking types, and can
also enable or disable picking of the children.
Hint: insert a Shape node before adding geometry or Appearance.
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 |
| 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. |
| 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). |
| objectType |
[objectType accessType inputOutput, type MFString CDATA ( ALL|NONE|TERRAIN|... ) "ALL"]
The objectType field specifies a set of labels used in the picking process. Each
string specified is treated as an independent label that needs to be matched against
the same type in one of the pick sensor instances.
Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to
intersect a pick sensor with objectType value "GROUND" fails since the objectType
values do not match.
Example: the special value "ALL" means that each node is available for picking regardless
of the type specified by the pick sensor.
Example: the special value "NONE" effectively disables all picking for this node and is the
equivalent of setting the pickable field to false.
Hint: authors may define any value for objectType.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks". |
| pickable |
[pickable accessType inputOutput, type SFBool (true|false) "true"]
The pickable field determines whether pick traversal is performed on this node or
its children.
Hint: pickable only affects children accessed through the transformation hierarchy of
the parent.
Warning: if one or more of the children of this instance is accessible through another transformation
hierarchy through DEF/USE that still has picking enabled, they are still pickable
through that path only. |
| 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 |
PixelTexture |
[inherits X3DTexture2DNode]
PixelTexture creates a 2D-image texture map using a numeric array of pixel values.
Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s,
t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.
Hint: this is a good way to bundle image(s) into a single scene file, avoiding multiple
downloads.
Hint: X3D-Edit includes PixelTexture image-conversion import capabilities. https://savage.nps.edu/X3D-Edit/images/PixelTextureImportImage.png
Warning: aggregate file size can grow dramatically.
Hint: can contain a single TextureProperties node.
Hint: insert Shape and Appearance nodes before adding texture.
Hint: X3D Scene Authoring Hints, Images and Videos https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
Warning: see ComposedCubeMapTexture and TextureBackground for special containerField values.
Hint: if a texture is opaque, omitting values in the alpha channel can help avoid rendering
artifacts related to transparency.
Hint: Texture coordinates are reapplied (or else recomputed if textureTransform field
initially NULL) whenever the corresponding vertex-based geometry changes.
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
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 |
| textureProperties |
[textureProperties accessType initializeOnly, type SFNode singleton, NULL node] [TextureProperties]
Single contained TextureProperties node that can specify additional visual attributes
applied to corresponding texture images. |
| 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). |
| image |
[image accessType inputOutput, type SFImage CDATA "0 0 0"]
Defines image: width, height, number_of_components per each pixel value, and list
of pixel_values. Note that width and height are pixel count, and allowed values for
RGBA number_of_components in each pixel value are 1 (intensity), 2 (intensity alpha),
3 (red green blue), 4 (red green blue alpha-opacity).
Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are
different.
Example: intensity [1 2 1 0xFF 0x00]
Example: intensity-alpha [2 2 1 0 255 255 0]
Example: red-green-blue [2 4 3 0xFF0000 0xFF00 0 0 0 0 0xFFFFFF 0xFFFF00]
Example: red-green-blue-alpha [2 2 4 0xFFFFFFAA 0xFFFF00AA 0x11111111AA 0x787800AA]
Hint: it is easier to understand hexadecimal values for each pixel, but integer values
are also allowed.
Hint: the array of pixel values has length = (width*height).
Hint: the full list of integers in this field has length = (width*height + 3). |
| repeatS |
[repeatS accessType initializeOnly, type SFBool (true|false) "true"]
Whether to repeat texture along S axis horizontally from left to right. |
| repeatT |
[repeatT accessType initializeOnly, type SFBool (true|false) "true"]
Whether to repeat texture along T axis vertically from top to bottom. |
| containerField |
[containerField type NMTOKEN (texture|back|bottom|front|left|right|top|backTexture|bottomTexture|frontTexture|leftTexture|rightTexture|topTexture|baseTexture|emissiveTexture|metallicRoughnessTexture|normalTexture|occlusionTexture)
"texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
PixelTexture3D |
(X3D version 3.1 or later) [inherits X3DTexture3DNode]
PixelTexture3D defines a 3D image-based texture map as an explicit array of pixel
values (image field).
Hint: can contain a single TextureProperties node.
Hint: insert Shape and Appearance nodes before adding texture.
Hint: X3D Architecture 33.2.2 3D texturing concepts https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texture3D.html#3DTextureconcepts
Warning: requires X3D profile='Full' or else include <component name='Texturing3D' level='1'/>
|
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 |
| textureProperties |
[textureProperties accessType initializeOnly, type SFNode singleton, NULL node] [TextureProperties]
Single contained TextureProperties node that can specify additional visual attributes
applied to corresponding texture images. |
| 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). |
| image |
[image accessType inputOutput, type MFInt32 CDATA "0 0 0 0"]
image describes raw data for this 3D texture: number of components to the image
[0,4], width, height and depth of the texture, followed by (width x height x depth)
pixel values.
Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are
different. |
| repeatR |
[repeatR accessType initializeOnly, type SFBool (true|false) "false"]
Whether to repeat texture along R axis from front to back. |
| repeatS |
[repeatS accessType initializeOnly, type SFBool (true|false) "false"]
Whether to repeat texture along S axis horizontally from left to right. |
| repeatT |
[repeatT accessType initializeOnly, type SFBool (true|false) "false"]
Whether to repeat texture along T axis vertically from top to bottom. |
| containerField |
[containerField type NMTOKEN "texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
PlaneSensor |
[inherits X3DDragSensorNode]
PlaneSensor converts pointing device motion into 2D translation parallel to the
local Z=0 plane.
Hint: create a LineSensor by constraining one axis:
(minPosition.x=maxPosition.x) or (minPosition.y=maxPosition.y).
Hint: this sensor detects user interactions affecting peer nodes and their child geometry.
Hint: add semi-transparent surrounding geometry to see the effect of the sensor.
Hint: X3D Architecture 20.2.1 Overview of pointing device sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html#OverviewOfPointingDeviceSensors
Hint: X3D Architecture 20.2.2 Drag sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html#DragSensors
Hint: X3D Architecture 20.2.3 Activating and manipulating pointing device sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html#Activatingandmanipulating
Hint: example scenes and authoring assets at https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter08UserInteractivity |
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. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: include space characters since a description is not a DEF identifier. Write short
phrases that make descriptions clear and readable.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| minPosition |
[minPosition accessType inputOutput, type SFVec2f CDATA "0 0"]
minPosition and maxPosition clamp translations to a range of values measured from
origin of Z=0 plane default maxPosition < minPosition means no clamping.
Hint: create a LineSensor by constraining one axis (minPosition.x=maxPosition.x) or (minPosition.y=maxPosition.y).
|
| maxPosition |
[maxPosition accessType inputOutput, type SFVec2f CDATA "-1 -1"]
minPosition and maxPosition clamp translations to a range of values measured from
origin of Z=0 plane default maxPosition < minPosition means no clamping.
Hint: create a LineSensor by constraining one axis (minPosition.x=maxPosition.x) or (minPosition.y=maxPosition.y).
|
| autoOffset |
[autoOffset accessType inputOutput, type SFBool (true|false) "true"]
Determines whether previous offset values are remembered/accumulated. |
| axisRotation |
[axisRotation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
axisRotation determines local sensor coordinate system by rotating the local coordinate
system. |
| offset |
[offset accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Sends event and remembers last value sensed.
Warning: ROUTE connecting translation_changed to set_offset creates a self-reinforcing positive
feedback loop and results in unmanageable response. |
| trackPoint_changed |
[trackPoint_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
trackPoint_changed events give intersection point of bearing with sensor's virtual
geometry.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events.
Warning: trackPoint_changed events represent unclamped intersection points on plane surface.
Browsers can interpret drags off of the surface in various ways. Note that translation_changed
events are clamped by minPosition/maxPosition and thus may be preferable. |
| translation_changed |
[translation_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
translation_changed events equal sum of relative translation change plus offset
value.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
Select geometry by activating the pointing device (for example, clicking the mouse)
to generate isActive events. Output event isActive=true is sent when geometry is selected
(for example, when primary mouse button is pressed), output event isActive=false is
sent when geometry is deselected (for example, when primary mouse button is released).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isOver |
[isOver accessType outputOnly, type SFBool #FIXED ""]
Hover over geometry by aiming the mouse (or pointing device) to generate isOver
events. Sensor sends output event isOver=true event when pointing device moves over
sensor's geometry, and later sends output event isOver=false event when pointing device
moves off.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| 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 |
|
PointEmitter |
(X3D version 3.2 or later) [inherits X3DParticleEmitterNode]
PointEmitter generates particles from a specific point in space using the specified
direction and speed. |
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. |
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 1 0"]
Initial direction from which particles emanate. |
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables production of particles from this emitter node. If operating when
turned off, existing particles complete their rendering process. |
| position |
[position accessType inputOutput, type SFVec3f CDATA "0 1 0"]
Point from which particles emanate. |
| mass |
[mass accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Basic mass of each particle, defined in mass base units (default is kilograms).
Hint: mass is needed if gravity or other force-related calculations are performed on a
per-particle basis.
Hint: https://en.wikipedia.org/wiki/Kilogram
Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates |
| speed |
[speed accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
Initial linear speed (default is m/s) imparted to all particles along their direction
of movement. |
| surfaceArea |
[surfaceArea accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Particle surface area in area base units (default is meters squared). Surface area
is used for calculations such as wind effects per particle.
Hint: surfaceArea value represents average frontal area presented to the wind.
Hint: assumes spherical model for each particle (i.e., surface area is the same regardless
of direction). |
| variation |
[variation accessType inputOutput, type SFFloat CDATA "0.25"] [0,+β)
Multiplier for the randomness used to control the range of possible output values.
The bigger the value, the more random the output and the bigger the range of possible
initial values possible.
Hint: variation of zero does not allow any randomness. |
| containerField |
[containerField type NMTOKEN "emitter"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
PointLight |
[inherits X3DLightNode]
PointLight is a single light source that illuminates outwards in all directions.
Lighting illuminates all geometry except lines and points. By default, light scope
only illuminates peer geometry and children nodes within the scene graph hierarchy.
Lights have no visible shape themselves and lighting effects continue through any
intermediate geometry.
Hint: the bound NavigationInfo controls whether headlight is enabled on/off. |
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. |
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables this light source. |
| color |
[color accessType inputOutput, type SFColor CDATA "1 1 1"] [0,1]
color of light, applied to colors of objects.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| location |
[location accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position of light relative to local coordinate system. |
| intensity |
[intensity accessType inputOutput, type SFFloat CDATA "1"] [0,+β]
Brightness of direct emission from the light. |
| ambientIntensity |
[ambientIntensity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
Brightness of ambient (nondirectional background) emission from the light. |
| shadowIntensity |
[shadowIntensity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
shadowIntensity field defines how much light is obscured by shapes that cast shadows,
ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured,
full-intensity shadows). |
| shadows |
[shadows accessType inputOutput, type SFBool (true|false) "false"]
shadows field indicates whether or not this light casts a shadow behind illuminated
X3DShapeNode geometry. |
| radius |
[radius accessType inputOutput, type SFFloat CDATA "100"]
Maximum effective distance of light relative to local light position, affected by
ancestor scaling. |
| attenuation |
[attenuation accessType inputOutput, type SFVec3f CDATA "1 0 0"]
Constant, linear-distance and squared-distance dropoff factors as radial distance
increases from the source.
Hint: attenuation = 1/max(attenuation[0] + attenuation[1] β¨― r + attenuation[2] β¨― r2 ,
1) |
| global |
(X3D version 3.1 or later) [global accessType inputOutput, type SFBool (true|false) "true"]
Global lights illuminate all objects within their volume of lighting influence.
Scoped lights only illuminate objects within the same transformation hierarchy.
Warning: DirectionalLight default global=false to limit scope and avoid inadvertently illuminating
every object in a large scene. PointLight and SpotLight default global=true since
their effects are each limited by maximum radius value. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
PointPickSensor |
(X3D version 3.2 or later) [inherits X3DPickSensorNode]
PointPickSensor tests one or more pickingGeometry points in space as lying inside
the provided pickTarget geometry. For each pickingGeometry PointSet coordinate point
that lies inside the pickTarget geometry, a pickedPoint coordinate is returned along
with a corresponding pickedGeometry node inside which the point lies.
Hint: because points represent an infinitely small location in space, sortOrder values
CLOSEST and ALL_SORTED are defined to mean ANY and ALL respectively.
Hint: picking is performed between rendered frames of the event model. An author sets
up the picking request in one frame by placing a LinePickSensor in the desired location.
At the start of the next frame, any picking intersections are reported by the pick
sensor.
Hint: picking notification is performed at the start of the frame for all enabled pick
sensors once all other sensors are processed.
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
Warning: order of contained nodes is significant, single pickingGeometry node must precede
pickTarget node array.
Hint: PointSet can be used for pickingGeometry node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| pickingGeometry |
[pickingGeometry accessType inputOutput, type SFNode singleton, NULL node] [PointSet]
pickingGeometry specifies the exact geometry coordinates that are used to perform
the intersection testing of the picking operation. |
| pickTarget |
[pickTarget accessType inputOutput, type MFNode array, empty list] [X3DGroupingNode | X3DShapeNode | Inline]
pickTarget specifies the list of nodes against which picking operations are performed.
All nodes declared in this field and their descendents are evaluated for intersections.
|
| pickedGeometry |
[pickedGeometry accessType outputOnly, type MFNode #FIXED ""]
Output event containing the node or nodes that have been found to intersect with
the picking geometry from the last time this node performed a picking operation, given
in the local coordinate system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| 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 indicates when the intersecting object is picked by the picking geometry.
Output event isActive=true gets sent once a picked item is found. Output event isActive=false
gets sent once no picked item is found.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| intersectionType |
[intersectionType accessType initializeOnly, type SFString CDATA ( GEOMETRY|BOUNDS ) "BOUNDS"]
intersectionType specifies precision of the collision computation.
Hint: intersectionType constants may be extended by the browser to provide additional
options.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| matchCriterion |
[matchCriterion accessType inputOutput, type SFString CDATA ( MATCH_ANY|MATCH_EVERY|MATCH_ONLY_ONE ) "MATCH_ANY"]
defines whether the intersection test (i.e. pick) by this X3DPickSensorNode must
match one or more objectType. Specifically MATCH_ANY means any match of objectType
values is acceptable, MATCH_EVERY means that every objectType value in this node shall
match an objectType value in the X3DPickableObject, and MATCH_ONLY_ONE means that
one and only one objectType value can match. |
| objectType |
[objectType accessType inputOutput, type MFString CDATA ( ALL|NONE|TERRAIN|... ) "ALL"]
The objectType field specifies a set of labels used in the picking process. Each
string specified is treated as an independent label that needs to be matched against
the same type in one of the pick sensor instances.
Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to
intersect a pick sensor with objectType value "GROUND" fails since the objectType
values do not match.
Example: the special value "ALL" means that each node is available for picking regardless
of the type specified by the pick sensor.
Example: the special value "NONE" effectively disables all picking for this node and is the
equivalent of setting the pickable field of the corresponding PickableGroup to false.
Hint: authors may define any value for objectType.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks". |
| sortOrder |
[sortOrder accessType initializeOnly, type SFString CDATA ( ANY|CLOSEST|ALL|ALL_SORTED|... ) "CLOSEST"]
The sortOrder field determines the order provided for picked output events.
Example: ANY means any single object that can satisfy picking conditions for this pick sensor.
Consistency of results is not guaranteed.
Example: ALL means that every object that satisfies the picking conditions for this pick
sensor shall be returned.
Example: ALL_SORTED means that every object that satisfies the picking conditions for this
pick sensor shall be returned with the order of the output fields provided in a distance-sorted
order from closest to farthest away. The exact algorithm for sorting is defined by
the individual node definitions.
Example: CLOSEST means that the closest object by distance that satisfies the conditions
of this pick sensor. *The exact algorithm for distance determination shall be defined
by individual node definitions*.
Hint: browser implementations may define additional values and algorithms beyond these
four required values.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| pickedPoint |
[pickedPoint accessType outputOnly, type MFVec3f CDATA #FIXED ""]
Output event containing 3D points on surface of underlying pickingGeometry computed
by the picking intersection computations, given in the local coordinate system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| 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 |
|
PointProperties |
[inherits X3DAppearanceChildNode]
PointProperties allows precise fine-grained control over the rendering style of
PointSet node points inside the same Shape.
Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related
shapes in a scene.
Hint: When an X3DTextureNode is defined in the same Appearance instance as PointProperties
node, the points of a PointSet shall be displayed as point sprites using the given
texture(s).
Warning: requires X3D profile='Full' or else include <component name='Shape' level='5'/>
|
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. |
| attenuation |
[attenuation accessType inputOutput, type SFVec3f CDATA "1 0 0"] [0,+β)
attenuation array values [a, b, c] are set to default values if undefined. Together
these parameters define attenuation factor 1/(a + bΓr + cΓr^2) where r is the distance
from observer position (current viewpoint) to each point.
Hint: nominal point size is multiplied by attenuation factor and then clipped to a minimum
value of pointSizeMinValue Γ minimum renderable point size, then clipped to maximum
size of pointSizeMaxValue Γ minimum renderable point size. |
| pointSizeMaxValue |
[pointSizeMaxValue accessType inputOutput, type SFFloat CDATA "1"] [0,+β)
pointSizeMaxValue is maximum allowed scaling factor on nominal browser point scaling.
Warning: maintain pointSizeMinValue <= pointSizeMaxValue. |
| pointSizeMinValue |
[pointSizeMinValue accessType inputOutput, type SFFloat CDATA "1"] [0,+β)
pointSizeMinValue is minimum allowed scaling factor on nominal browser point scaling.
Warning: maintain pointSizeMinValue <= pointSizeMaxValue. |
| pointSizeScaleFactor |
[pointSizeScaleFactor accessType inputOutput, type SFFloat CDATA "1"] [1,+β)
Nominal rendered point size is a browser-dependent minimum renderable point size,
which is then multiplied by an additional pointSizeScaleFactor (which is greater than
or equal to 1).
Hint: additional sizing modifications are determined by pointSizeMinValue, pointSizeMaxValue,
and attenuation array. |
| containerField |
[containerField type NMTOKEN "lineProperties"]
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 |
PointSet |
[inherits X3DGeometryNode]
PointSet is a node that contains a set of colored 3D points, represented by contained
Color|ColorRGBA and Coordinate|CoordinateDouble nodes.
Hint: Point (geometry) https://en.wikipedia.org/wiki/Point_(geometry)
Hint: either values in a contained Color node, or else Material emissiveColor in corresponding
Appearance node, are used for rendering lines and points.
Warning: use a different color (or Material emissiveColor) than the Background color, otherwise
geometry is invisible.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: each point is displayed independently, no other PointSet attributes for rendering
are provided. |
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 |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| 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 "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 |
Polyline2D |
[inherits X3DGeometryNode]
Polyline2D is a geometry node that defines a connected set of vertices in a contiguous
set of line segments in X-Y plane.
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.
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. |
| lineSegments |
[lineSegments accessType initializeOnly, type MFVec2f CDATA #FIXED ""]
Coordinates of vertices connected into contiguous Polyline2D.
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 |
|
PolylineEmitter |
(X3D version 3.2 or later) [inherits X3DParticleEmitterNode]
PolylineEmitter emits particles along a single polyline. The coordinates for the
line along which particles should be randomly generated are taken from a combination
of the coord and coordIndex fields. The starting point for generating particles is
randomly distributed along this line and given the initial speed and direction.
Hint: if no coordinates are available, PolylineEmitter acts like a point source located
at local origin. |
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. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Coordinates for the line along which particles are randomly generated.
Warning: If no coordinates are available, PolylineEmitter acts like a point source located
at local origin. |
| coordIndex |
[coordIndex accessType initializeOnly, type MFInt32 CDATA "-1"] [-1,+β)
coordIndex indices are applied to contained Coordinate values in order to define
randomly generated initial geometry of the particles.
Warning: If no coordinates are available, PolylineEmitter acts like a point source located
at local origin.
Warning: coordIndex is required in order to connect contained coordinate point values. |
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 1 0"]
Initial direction from which particles emanate. |
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables production of particles from this emitter node. If operating when
turned off, existing particles complete their rendering process. |
| mass |
[mass accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Basic mass of each particle, defined in mass base units (default is kilograms).
Hint: mass is needed if gravity or other force-related calculations are performed on a
per-particle basis.
Hint: https://en.wikipedia.org/wiki/Kilogram
Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates |
| speed |
[speed accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
Initial linear speed (default is m/s) imparted to all particles along their direction
of movement. |
| surfaceArea |
[surfaceArea accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Particle surface area in area base units (default is meters squared). Surface area
is used for calculations such as wind effects per particle.
Hint: surfaceArea value represents average frontal area presented to the wind.
Hint: assumes spherical model for each particle (i.e., surface area is the same regardless
of direction). |
| variation |
[variation accessType inputOutput, type SFFloat CDATA "0.25"] [0,+β)
Multiplier for the randomness used to control the range of possible output values.
The bigger the value, the more random the output and the bigger the range of possible
initial values possible.
Hint: variation of zero does not allow any randomness. |
| containerField |
[containerField type NMTOKEN "emitter"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
Polypoint2D |
[inherits X3DGeometryNode]
Polypoint2D is a geometry node that defines a set of 2D points in X-Y plane.
Hint: insert a Shape node before adding geometry or Appearance.
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. |
| point |
[point accessType initializeOnly, type MFVec2f CDATA #FIXED ""]
2D coordinates of vertices.
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 |
PositionChaser |
(X3D version 3.2 or later) [inherits X3DChaserNode]
PositionChaser generates a series of position values that progressively change from
initial value to destination value.
Hint: ROUTE value_changed output events to a <Transform> node's translation field, for
example. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 SFVec3f CDATA "0 0 0"]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type SFVec3f 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 SFVec3f 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 SFVec3f 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 |
PositionChaser2D |
(X3D version 3.2 or later) [inherits X3DChaserNode]
PositionChaser2D generates a series of 2D position values that progressively change
from initial value to destination value.
Hint: ROUTE value_changed output events to a <TextureTransform> node's translation field,
for example. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 SFVec2f CDATA "0 0"]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type SFVec2f CDATA "0 0"]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type SFVec2f 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 SFVec2f 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 SFVec2f 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 |
|
PositionDamper |
(X3D version 3.2 or later) [inherits X3DDamperNode]
PositionDamper generates a series of position values that progressively change from
initial value to destination value.
Hint: ROUTE value_changed output events to a <Transform> node's translation field, for
example. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 SFVec3f CDATA "0 0 0"]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type SFVec3f 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 SFVec3f 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 SFVec3f 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 |
|
PositionDamper2D |
(X3D version 3.2 or later) [inherits X3DDamperNode]
PositionDamper2D generates a series of 2D floating-point values that progressively
change from initial value to destination value.
Hint: ROUTE value_changed output events to a <TextureTransform> node's translation field,
for example. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 SFVec2f CDATA "0 0"]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type SFVec2f CDATA "0 0"]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type SFVec2f 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 SFVec2f 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 SFVec2f 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 |
PositionInterpolator |
[inherits X3DInterpolatorNode]
PositionInterpolator generates a series of 3-tuple SFVec3f values. Authors can ROUTE
value_changed output events to a Transform node's translation field or another SFVec3f
field.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
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 MFVec3f CDATA #IMPLIED]
Output values for linear interpolation, each corresponding to an input-fraction
value in the key array.
Hint: identical adjacent entries in keyValue array have the effect of defining constant-value
step functions. https://en.wikipedia.org/wiki/Step_function
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 SFVec3f 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 |
PositionInterpolator2D |
[inherits X3DInterpolatorNode]
PositionInterpolator2D generates a series of SFVec2f values. Authors can ROUTE value_changed
output events to a SFVec2f attribute.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction.
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='3'/>
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.
Hint: number of keyValues must be an integer multiple of the number of keys!
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed
outputOnlys.
Warning: values in key array shall be monotonically non-decreasing, meaning that each value
is greater than or equal to the preceding value.
Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals
can be defined with arbitrary bounds. |
| keyValue |
[keyValue accessType inputOutput, type MFVec2f CDATA #IMPLIED]
Output values for linear interpolation, each corresponding to an input-fraction
value in the key array.
Hint: identical adjacent entries in keyValue array have the effect of defining constant-value
step functions. https://en.wikipedia.org/wiki/Step_function
Hint: number of keyValues must be an integer multiple of the number of keys!
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed
outputOnlys. |
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input key for corresponding keyValue output.
Hint: set_fraction values are typically in same range interval as values in the key array.
Response to an input set_fraction value less than minimum is equivalent to minimum
key, and response to an input set_fraction value greater than maximum is equivalent
to maximum key.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| value_changed |
[value_changed accessType outputOnly, type SFVec2f CDATA #FIXED ""]
Linearly interpolated output value determined by current key time and corresponding
keyValue pair.
Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive
superfluous events that have no effect.
Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed
outputOnlys.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
PrimitivePickSensor |
(X3D version 3.2 or later) [inherits X3DPickSensorNode]
PrimitivePickSensor tests picking intersections using one of the basic primitive
shapes specified in the pickingGeometry field [Cone|Cylinder|Sphere|Box] against the
pickTarget geometry.
Warning: boolean fields used to control visibility of primitive pickingGeometry subsections
are ignored when evaluating picking intersections.
Example: a Cylinder without end caps is still treated as an enclosed Cylinder.
Hint: Sorting is defined based on the primitive type as follows. For Cone, the closest
picked primitive is defined to be that closest to the vertex point. For Cylinder,
Box, and Sphere, the closest picked primitive is defined to be that closest to the
center.
Hint: picking is performed between rendered frames of the event model. An author sets
up the picking request in one frame by placing a LinePickSensor in the desired location.
At the start of the next frame, any picking intersections are reported by the pick
sensor.
Hint: picking notification is performed at the start of the frame for all enabled pick
sensors once all other sensors are processed.
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
Warning: order of contained nodes is significant, single pickingGeometry node must precede
pickTarget node array.
Hint: Box, Cone, Cylinder or Sphere can be used for pickingGeometry node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| pickingGeometry |
[pickingGeometry accessType inputOutput, type SFNode singleton, NULL node] [Cone | Cylinder | Sphere | Box]
pickingGeometry specifies the exact geometry coordinates that are used to perform
the intersection testing of the picking operation. |
| pickTarget |
[pickTarget accessType inputOutput, type MFNode array, empty list] [X3DGroupingNode | X3DShapeNode | Inline]
pickTarget specifies the list of nodes against which picking operations are performed.
All nodes declared in this field and their descendents are evaluated for intersections.
|
| pickedGeometry |
[pickedGeometry accessType outputOnly, type MFNode #FIXED ""]
Output event containing the node or nodes that have been found to intersect with
the picking geometry from the last time this node performed a picking operation, given
in the local coordinate system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| 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 indicates when the intersecting object is picked by the picking geometry.
Output event isActive=true gets sent once a picked item is found. Output event isActive=false
gets sent once no picked item is found.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| intersectionType |
[intersectionType accessType initializeOnly, type SFString CDATA ( GEOMETRY|BOUNDS ) "BOUNDS"]
intersectionType specifies precision of the collision computation.
Hint: intersectionType constants may be extended by the browser to provide additional
options.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| matchCriterion |
[matchCriterion accessType inputOutput, type SFString CDATA ( MATCH_ANY|MATCH_EVERY|MATCH_ONLY_ONE ) "MATCH_ANY"]
defines whether the intersection test (i.e. pick) by this X3DPickSensorNode must
match one or more objectType. Specifically MATCH_ANY means any match of objectType
values is acceptable, MATCH_EVERY means that every objectType value in this node shall
match an objectType value in the X3DPickableObject, and MATCH_ONLY_ONE means that
one and only one objectType value can match. |
| objectType |
[objectType accessType inputOutput, type MFString CDATA ( ALL|NONE|TERRAIN|... ) "ALL"]
The objectType field specifies a set of labels used in the picking process. Each
string specified is treated as an independent label that needs to be matched against
the same type in one of the pick sensor instances.
Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to
intersect a pick sensor with objectType value "GROUND" fails since the objectType
values do not match.
Example: the special value "ALL" means that each node is available for picking regardless
of the type specified by the pick sensor.
Example: the special value "NONE" effectively disables all picking for this node and is the
equivalent of setting the pickable field of the corresponding PickableGroup to false.
Hint: authors may define any value for objectType.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks". |
| sortOrder |
[sortOrder accessType initializeOnly, type SFString CDATA ( ANY|CLOSEST|ALL|ALL_SORTED|... ) "CLOSEST"]
The sortOrder field determines the order provided for picked output events.
Example: ANY means any single object that can satisfy picking conditions for this pick sensor.
Consistency of results is not guaranteed.
Example: ALL means that every object that satisfies the picking conditions for this pick
sensor shall be returned.
Example: ALL_SORTED means that every object that satisfies the picking conditions for this
pick sensor shall be returned with the order of the output fields provided in a distance-sorted
order from closest to farthest away. The exact algorithm for sorting is defined by
the individual node definitions.
Example: CLOSEST means that the closest object by distance that satisfies the conditions
of this pick sensor. *The exact algorithm for distance determination shall be defined
by individual node definitions*.
Hint: browser implementations may define additional values and algorithms beyond these
four required values.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| 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 |
|
ProgramShader |
(X3D version 3.1 or later) [inherits X3DShaderNode]
ProgramShader defines a shader that consists of one or more individually programmable,
self-contained pieces.
ProgramShader contains IS/connect and programs [ShaderProgram] nodes.
Warning: ProgramShader contains no field declarations and no plain-text CDATA block source
code.
Hint: apply default containerField='shaders' when parent node is Appearance. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| programs |
[programs accessType inputOutput, type MFNode array, empty list] [ShaderProgram]
ProgramShader contains zero or more ShaderProgram node instances. In general, only
two ShaderProgram instances are needed: one each for vertex and fragment processing.
Hint: each shader language defines required behavior for processing this field. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| activate |
[activate accessType inputOnly, type SFBool (true|false)]
activate forces the shader to activate the contained objects.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| isSelected |
[isSelected accessType outputOnly, type SFBool (true|false)]
isSelected indicates this shader instance is selected for use by browser
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isValid |
[isValid accessType outputOnly, type SFBool (true|false)]
isValid indicates whether current shader objects can be run as a shader program.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| language |
[language accessType initializeOnly, type SFString CDATA #IMPLIED]
The language field indicates to the X3D player which shading language is used. The
language field may be used to optionally determine the language type if no MIME-type
information is available.
Hint: recognized values include "Cg" "GLSL" "HLSL". |
| containerField |
[containerField type NMTOKEN "shaders"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
ProjectionVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
ProjectionVolumeStyle uses voxel data to directly generate output color.
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 |
| 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. |
| intensityThreshold |
[intensityThreshold accessType inputOutput, type SFFloat CDATA "0"] [0,1]
Threshold value used when type=MIN (LMIP) or type=MAX (MIP).
Hint: ignored if type=AVERAGE (no thresholding). |
| type |
[type accessType inputOutput, type SFString CDATA ( MAX|MIN|AVERAGE ) MAX]
If type=MAX then Maximum Intensity Projection (MIP) or Least MIP (LMIP) algorithm
is used to generate output color. If type=MIN then Minimum Intensity Projection algorithm
is used. If type=AVERAGE then all voxels along ray are averaged.
Hint: type=AVERAGE matches a simple approximation of an X-ray.#10;
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| 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 |
ProtoBody |
[X3D statement]
ProtoBody statement follows the ProtoInterface statement in a ProtoDeclare statement,
providing the scene-subgraph node definitions.
Hint: initial scene node in a ProtoDeclare/ProtoBody statement determines this prototype's
node type.
Warning: only the first top-level node and its children are rendered, subsequent nodes (such
as Scripts and ROUTEs)
are active but are not drawn. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DNode]
ProtoBody can contain nodes, statements and comments. |
| 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 |
|
ProtoDeclare |
[X3D statement]
ProtoDeclare is a Prototype Declaration, defining a new node made up of other node(s).
ProtoDeclare contains ProtoInterface and ProtoBody statements.
Hint: ProtoInterface contains field interfaces using the <field> tag, then ProtoBody contains
the X3D nodes making up this prototype.
Hint: initial scene node in a ProtoDeclare/ProtoBody statement determines this prototype's
node type.
Hint: ProtoDeclare is a definition only, add corresponding ProtoInstance nodes later in
a scene to create new node instances.
Hint: Nested ProtoInstance and ProtoDeclare statements are allowed within a ProtoDeclare/ProtoBody.
Warning: a ProtoInstance node may not be instantiated inside its own ProtoDeclare or ExternProtoDeclare
declaration (i.e. recursive prototypes are illegal).
Hint: X3D Scene Authoring Hints, Inlines and Prototypes https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#InlinesPrototypes
Hint: X3D Architecture 7.2.5.8 PROTO statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#PROTOStatement
Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PROTOdefinitionsemantics
Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| ProtoInterface |
[X3D statement ProtoInterface]
Include an optional ProtoInterface statement if this ProtoDeclare has field declarations.
Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PROTOdefinitionsemantics
Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes |
| ProtoBody |
[X3D statement ProtoBody]
Include one ProtoBody statement after the ProtoInterface statement. |
| name |
[name type NMTOKEN #REQUIRED]
name of this prototype being declared.
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 |
| appinfo |
[appinfo type SFString CDATA #IMPLIED]
Application information to provide simple description usable as a tooltip, similar
to XML Schema appinfo tag. |
| documentation |
[documentation type SFString CDATA #IMPLIED]
Documentation url for further information, similar to XML Schema documentation tag.
|
| 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 |
ProtoInstance |
[X3D statement]
ProtoInstance creates an instance node of a locally or externally declared prototype
definition. ProtoDeclare/ExternProtoDeclare definitions are abstract, corresponding
ProtoInstance nodes are concrete. ProtoInstance nodes typically contain fieldValue
statements to override default field values defined in the original ProtoDeclare statement.
Hint: the node type of a ProtoInstance exactly matches the first node in the corresponding
ProtoDeclare/ProtoBody declaration.
Warning: be sure to correctly set the containerField value to match the intended field in
the parent node.
Warning: do not mismatch node types when placing a ProtoInstance in a scene graph. Most validation
tools will not catch this error.
Hint: scene authors can override default initializations of prototype fields by including
contained <fieldValue> elements.
Hint: Nested ProtoInstance and ProtoDeclare statements are allowed within a ProtoDeclare/ProtoBody.
Hint: if contained within a ProtoDeclare, then a ProtoInstance node can also contain IS/connect
statements for other defined fields.
Warning: a ProtoInstance node may not be instantiated inside its own ProtoDeclare or ExternProtoDeclare
declaration (i.e. recursive prototypes are illegal).
Warning: the local context of each ProtoInstance node must match the node type of the first
node in the original ProtoDeclare declaration.
Warning: ProtoInstance substitution for a Metadata* node might not validate. Workaround:
put metadata-typed ProtoInstance nodes as contained values within a parent MetadataSet
node.
Hint: X3D Scene Authoring Hints, Inlines and Prototypes https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#InlinesPrototypes
Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PROTOdefinitionsemantics
Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| fieldValue |
[X3D statement fieldValue]
Include fieldValue statements if this ProtoInstance overrides default values in
any of the original field declarations. |
| name |
[name type NMTOKEN #IMPLIED]
name of the prototype node being instanced.
Hint: must match name of corresponding ProtoDeclare or ExternProtoDeclare in this scene.
Warning: name must be specified unless this ProtoInstance is a USE node. Do not include name
with ProtoInstance USE since it is duplicative (i.e. name is already defined in the
DEF instance) and this approach avoids potential name 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 |
| 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.
Warning: do not define a name field in a USE node, the correct name can already be found
in the original ProtoInstance DEF node. |
| 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 |
|
ProtoInterface |
[X3D statement]
ProtoInterface is the first statement inside a ProtoDeclare statement and holds
field declarations. ProtoInterface is followed by a corresponding ProtoBody statement.
Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PROTOdefinitionsemantics
Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| field |
[X3D statement field]
Include a field statement for each field declaration in this ProtoDeclare's ProtoInterface.
|
| 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 |
|
ProximitySensor |
[inherits X3DEnvironmentalSensorNode]
ProximitySensor generates events when the viewer enters,
exits and moves within a region of space (defined by a box).
Hint: multiple USEd instances are cumulative, but avoid overlaps.
Hint: can first use Transform to relocate/reorient box.
Hint: surround entire world to start behaviors once scene is loaded. |
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. |
| 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. |
| center |
[center accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position offset from origin of local coordinate system. |
| size |
[size accessType inputOutput, type SFVec3f CDATA "0 0 0"] [0,+β)
size of Proximity box around center location, oriented within local transformation
frame.
Hint: size 0 0 0 is same as enabled false. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent as viewer enters/exits Proximity box. isActive=true
when viewer enters Proximity box, isActive=false when viewer exits Proximity box.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| position_changed |
[position_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
Sends translation event relative to center.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| orientation_changed |
[orientation_changed accessType outputOnly, type SFRotation CDATA #FIXED ""]
Sends rotation event relative to center.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| centerOfRotation_changed |
[centerOfRotation_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
Sends changed centerOfRotation values, likely caused by user interaction.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| enterTime |
[enterTime accessType outputOnly, type SFTime CDATA #FIXED ""]
Time event generated when user's camera enters the box.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| exitTime |
[exitTime accessType outputOnly, type SFTime CDATA #FIXED ""]
Time event generated when user's camera exits the box.
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 |
|
QuadSet |
(X3D version 3.1 or later) [inherits X3DComposedGeometryNode]
QuadSet is a geometry node that defines planar quadrilaterals. QuadSet contains
a Coordinate|CoordinateDouble node, and can also contain Color|ColorRGBA, Normal and
TextureCoordinate nodes.
Hint: Quadrilateral https://en.wikipedia.org/wiki/Quadrilateral
Hint: color, normal and texCoord values are applied in the same order as coord values.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content.
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='1'/>
Warning: rendering characteristics are undefined if polygons are not planar.
Warning: avoid self-intersecting polygon line segments, otherwise defined geometry is irregular
and rendering results are undefined. |
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 |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate
node that can specify coordinates for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color|ColorRGBA values are applied to each point vertex (true) or to each
polygon face (false).
Warning: the provided value of QuadSet colorPerVertex field is ignored and always treated
as true.
Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding
Appearance and material/texture values.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or to
each polygon face (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. |
| 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.
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 |
ReceiverPdu |
[inherits X3DNetworkSensorNode, implements X3DBoundedObject, X3DVisibleObject]
ReceiverPdu is a networked Protocol Data Unit (PDU) information node that transmits
the state of radio frequency (RF) receivers modeled in a simulation.
Hint: ReceiverPdu packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
Hint: Savage Developers Guide on DIS https://savage.nps.edu/Savage/developers.html#DIS
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
Warning: requires X3D profile='Full' or else include <component name='DIS' level='1'/> |
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. |
| 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 the sensor node. |
| whichGeometry |
[whichGeometry accessType inputOutput, type SFInt32 CDATA "1"]
Select geometry to render: -1 for no geometry, 0 for text trace, 1 for default geometry,
(optional) higher values to render different states. |
| 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. |
| entityID |
[entityID accessType inputOutput, type SFInt32 CDATA "0"]
EntityID unique ID for entity within that application. |
| applicationID |
[applicationID accessType inputOutput, type SFInt32 CDATA "0"]
Each simulation application that can respond to simulation management PDUs needs
to have a unique applicationID. |
| siteID |
[siteID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise siteID of the participating LAN or organization. |
| readInterval |
[readInterval accessType inputOutput, type SFTime CDATA "0.1"] [0,+β)
Seconds between read updates, 0 means no reading.
Hint: readInterval is a nonnegative SFTime duration interval, not an absolute clock time.
|
| writeInterval |
[writeInterval accessType inputOutput, type SFTime CDATA "1.0"] [0,+β)
Seconds between write updates, 0 means no writing (sending).
Hint: writeInterval is a nonnegative SFTime duration interval, not an absolute clock time.
|
| networkMode |
[networkMode accessType inputOutput, type SFString CDATA ( standAlone|networkReader|networkWriter ) standAlone]
Whether this entity is ignoring the network, sending DIS packets to the network,
or receiving DIS packets from the network. (1) standAlone: ignore network but still
respond to events in local scene. (2) networkReader: listen to network and read PDU
packets at readInterval, act as remotely linked copy of entity. (3) networkWriter:
send PDU packets to network at writeInterval, act as master entity. Default value
"standAlone" ensures that DIS network activation within a scene as networkReader or
networkWriter is intentional.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values.
Warning: network activity may have associated security issues. |
| isStandAlone |
[isStandAlone accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='local' (ignore network but still respond to local events).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isNetworkReader |
[isNetworkReader accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='remote' (listen to network as copy of remote entity).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isNetworkWriter |
[isNetworkWriter accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='master' (output to network as master entity at writeInterval).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| address |
[address accessType inputOutput, type SFString CDATA localhost]
Multicast network address, or else 'localhost';
Example: 224.2.181.145. |
| port |
[port accessType inputOutput, type SFInt32 CDATA "0"]
Multicast network port, for example: 3000. |
| multicastRelayHost |
[multicastRelayHost accessType inputOutput, type SFString CDATA #IMPLIED]
Fallback server address if multicast not available locally. For example: track.nps.edu.
|
| multicastRelayPort |
[multicastRelayPort accessType inputOutput, type SFInt32 CDATA "0"]
Fallback server port if multicast not available locally. For example: 8010. |
| rtpHeaderExpected |
[rtpHeaderExpected accessType inputOutput, type SFBool (true|false) "false"]
Whether RTP headers are prepended to DIS PDUs. |
| isRtpHeaderHeard |
[isRtpHeaderHeard accessType outputOnly, type SFBool #FIXED ""]
Whether incoming DIS packets have an RTP header prepended.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
confirm whether there has been a recent network update.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| timestamp |
[timestamp accessType outputOnly, type SFTime CDATA #FIXED ""]
DIS timestamp in X3D units (value 0.0 matches 1 January 1970) in seconds.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| radioID |
[radioID accessType inputOutput, type SFInt32 CDATA "0"]
Identifies a particular radio within a given entity. |
| receivedPower |
[receivedPower accessType inputOutput, type SFFloat CDATA "0"]
receivedPower indicates radio frequency (RF) power received, in units of decibel-milliwatts
(dBm), after applying any propagation loss and antenna gain |
| receiverState |
[receiverState accessType inputOutput, type SFInt32 CDATA "0"]
receiverState indicates if receiver is currently idle or busy via one of these enumerated
values: 0 = off, 1 = on but not receiving, or 2 = on and receiving. |
| transmitterRadioID |
[transmitterRadioID accessType inputOutput, type SFInt32 CDATA "0"]
Identifies a particular radio within a given entity. |
| transmitterEntityID |
[transmitterEntityID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise transmitterEntityID is a unique ID for a single entity within
that application. |
| transmitterApplicationID |
[transmitterApplicationID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise transmitterApplicationID is unique for transmitter application
at that site. Each simulation application that can respond to simulation management
PDUs needs to have a unique applicationID. |
| transmitterSiteID |
[transmitterSiteID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise transmitterSiteID of the participating LAN or organization.
|
| geoCoords |
(X3D version 3.3 or later) [geoCoords accessType inputOutput, type SFVec3d CDATA "0 0 0"]
Geographic location (specified in current geoSystem coordinates) for children geometry
(specified in relative coordinate system, in meters).
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'/>
|
| geoSystem |
(X3D version 3.3 or later) [geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| 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 |
Rectangle2D |
[inherits X3DGeometryNode]
Rectangle2D is a geometry node that defines a 2D rectangle in X-Y plane.
Hint: insert a Shape node before adding geometry or Appearance.
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. |
| size |
[size accessType initializeOnly, type SFVec2f CDATA "2 2"]
2D dimensions of Rectangle2D.
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 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 |
|
RigidBody |
(X3D version 3.2 or later) [inherits X3DChildNode]
RigidBody describes a collection of shapes with a mass distribution that is affected
by the physics model.
Contains a Sphere, Box, or Cone (containerField='massDensityModel') and multiple CollidableOffset
or CollidableShape nodes (containerField='geometry') for animating collidable geometry.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| geometry |
[geometry accessType inputOutput, type SFNode singleton, NULL node] [X3DNBodyCollidableNode]
The geometry field is used to connect the body modelled by the physics engine implementation
to the real geometry of the scene through the use of collidable nodes. This allows
the geometry to be connected directly to the physics model as well as collision detection.
Collidable nodes have their location set to the same location as the body instance
in which they are located. |
| massDensityModel |
[massDensityModel accessType inputOutput, type SFNode singleton, NULL node] [Sphere,Box,Cone]
The massDensityModel field is used to describe the geometry type and dimensions
used to calculate the mass density in the physics model. It is not rendered, nor modified
by the physics model. |
| 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. |
| angularDampingFactor |
[angularDampingFactor accessType inputOutput, type SFFloat CDATA "0.001"] [0,1]
angularDampingFactor automatically damps a portion of body motion over time. |
| angularVelocity |
[angularVelocity accessType inputOutput, type SFVec3f CDATA "0 0 0"]
angularVelocity sets constant velocity value to object every frame, and reports
updates by physics model.
Hint: initial value only applied during first frame if forces applied.
Warning: instantaneous velocity changes may lead to numerical instability. |
| autoDamp |
[autoDamp accessType inputOutput, type SFBool (true|false) "false"]
autoDamp enables/disables angularDampingFactor and linearDampingFactor. |
| autoDisable |
[autoDisable accessType inputOutput, type SFBool (true|false) "false"]
autoDisable toggles operation of disableAngularSpeed, disableLinearSpeed, disableTime.
|
| centerOfMass |
[centerOfMass accessType inputOutput, type SFFloat CDATA "0 0 0"]
centerOfMass defines local center of mass for physics calculations. |
| disableAngularSpeed |
[disableAngularSpeed accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
disableAngularSpeed defines lower-limit tolerance value when body is considered
at rest and not part of rigid body calculations, reducing numeric instabilities.
Hint: only activated if autoDisable='true' |
| disableLinearSpeed |
[disableLinearSpeed accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
disableLinearSpeed defines lower-limit tolerance value when body is considered at
rest and not part of rigid body calculation, reducing numeric instabilitiess.
Hint: only activated if autoDisable='true' |
| disableTime |
[disableTime accessType inputOutput, type SFTime CDATA "0"] [0,+β)
disableTime defines interval when body becomes at rest and not part of rigid body
calculations, reducing numeric instabilities.
Hint: only activated if autoDisable='true'
Hint: disableTime is an SFTime duration interval, not an absolute clock time. |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| finiteRotationAxis |
[finiteRotationAxis accessType inputOutput, type SFVec3f CDATA "0 1 0"]
finiteRotationAxis specifies vector around which the object rotates. |
| fixed |
[fixed accessType inputOutput, type SFBool (true|false) "true"]
fixed indicates whether body is able to move.
Hint: fixed is useful for indicating objects that do not move: walls, ground, etc. |
| forces |
[forces accessType inputOutput, type MFVec3f CDATA ""]
forces defines linear force values applied to the object every frame. |
| inertia |
[inertia accessType inputOutput, type SFMatrix3f CDATA "1 0 0, 0 1 0, 0 0 1"]
inertia matrix defines a 3x2 inertia tensor matrix.
Warning: only the first 6 values are used. |
| linearDampingFactor |
[linearDampingFactor accessType inputOutput, type SFFloat CDATA "0.001"] [0,1]
linearDampingFactor automatically damps a portion of body motion over time. |
| linearVelocity |
[linearVelocity accessType inputOutput, type SFVec3f CDATA "0 0 0"]
linearVelocity sets constant velocity value to object every frame, and reports updates
by physics model.
Hint: initial value only applied during first frame if forces applied.
Warning: instantaneous velocity changes may lead to numerical instability. |
| mass |
[mass accessType inputOutput, type SFFloat CDATA "1"] (0,1]
mass of the body in kilograms.
Warning: mass must be greater than 0.
Hint: https://en.wikipedia.org/wiki/Kilogram
Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates |
| orientation |
[orientation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
orientation sets body direction in world space, then reports physics updates. |
| position |
[position accessType inputOutput, type SFVec3f CDATA "0 0 0"]
position sets body location in world space, then reports physics updates. |
| torques |
[torques accessType inputOutput, type MFVec3f CDATA ""]
torques defines rotational force values applied to the object every frame. |
| useFiniteRotation |
[useFiniteRotation accessType inputOutput, type SFBool (true|false) "false"]
useFiniteRotation enables/disables higher-resolution, higher-cost computational
method for calculating rotations. |
| useGlobalGravity |
[useGlobalGravity accessType inputOutput, type SFBool (true|false) "true"]
useGlobalGravity indicates whether this particular body is influenced by parent
RigidBodyCollection's gravity setting.
Hint: contained sub-bodies are not affected by this setting. |
| 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 |
RigidBodyCollection |
(X3D version 3.2 or later) [inherits X3DChildNode]
RigidBodyCollection represents a system of bodies that interact within a single
physics model. |
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 |
| bodies |
[bodies accessType inputOutput, type MFNode array, empty list] [RigidBody]
Collection of top-level nodes that comprise a set of bodies evaluated as a single
set of interactions. |
| collider |
[collider accessType inputOutput, type SFNode singleton, NULL] [CollisionCollection]
The collider field associates a collision collection with this rigid body collection
allowing seamless updates and integration without the need to use the X3D event model.
|
| joints |
[joints accessType inputOutput, type MFNode array, empty list] [X3DRigidJointNode]
The joints field is used to register all joints between bodies contained in this
collection.
Warning: If a joint is connected between bodies in two different collections, the result
is implementation-dependent.
Warning: If a joint instance is registered with more than one collection, the results are
implementation dependent.
Warning: Joints not registered with any collection are not evaluated. |
| set_contacts |
[set_contacts accessType inputOnly, type SFNode singleton] [Contact]
set_contacts input field for Contact nodes provides per-frame information about
contacts between bodies.
Warning: it is an error to define this transient inputOnly field in an X3D file, instead
only use it a destination for ROUTE events. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| autoDisable |
[autoDisable accessType inputOutput, type SFBool (true|false) "false"]
autoDisable toggles operation of disableAngularSpeed, disableLinearSpeed, disableTime.
|
| constantForceMix |
[constantForceMix accessType inputOutput, type SFFloat CDATA "0.0001"] [0,+β)
constantForceMix modifies damping calculations by violating normal constraints while
applying small, constant forces in those calculations.
Hint: this allows joints and bodies to be a fraction springy, and helps to eliminate numerical
instability.
Hint: spring-driven or spongy connections can be emulated by combined use of errorCorrection
and constantForceMix. |
| contactSurfaceThickness |
[contactSurfaceThickness accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
contactSurfaceThickness defines how far bodies may interpenetrate after a collision,
allowing simulation of softer bodies that deform somewhat during collision. |
| disableAngularSpeed |
[disableAngularSpeed accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
disableAngularSpeed defines lower-limit tolerance value when body is considered
at rest and not part of rigid body calculations, reducing numeric instabilities.
Hint: only activated if autoDisable='true' |
| disableLinearSpeed |
[disableLinearSpeed accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
disableLinearSpeed defines lower-limit tolerance value when body is considered at
rest and not part of rigid body calculation, reducing numeric instabilitiess.
Hint: only activated if autoDisable='true' |
| disableTime |
[disableTime accessType inputOutput, type SFTime CDATA "0"] [0,+β)
disableTime defines interval when body becomes at rest and not part of rigid body
calculations, reducing numeric instabilities.
Hint: only activated if autoDisable='true'
Hint: disableTime is an SFTime duration interval, not an absolute clock time. |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| errorCorrection |
[errorCorrection accessType inputOutput, type SFFloat CDATA "0.8"] [0,1]
errorCorrection describes how quickly intersection errors due to floating-point
inaccuracies are resolved (0=no correction, 1=all corrected in single step). |
| gravity |
[gravity accessType inputOutput, type SFVec3f CDATA "0 -9.8 0"]
gravity indicates direction and strength of local gravity vector for this collection
of bodies (units m/sec^2). |
| iterations |
[iterations accessType inputOutput, type SFInt32 CDATA "10"] [0,+β)
iterations controls number of iterations performed over collectioned joints and
bodies during each evaluation. |
| maxCorrectionSpeed |
[maxCorrectionSpeed accessType inputOutput, type SFFloat CDATA "-1"] [0,+β)
or -1, maxCorrectionSpeed . |
| preferAccuracy |
[preferAccuracy accessType inputOutput, type SFBool (true|false) "true"]
preferAccuracy provides hint for performance preference: higher accuracy or faster
computational speed. |
| 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 |
ROUTE |
[X3D statement]
ROUTE connects output fields of event-producing nodes to input fields of event-consuming
nodes.
Warning: each ROUTE must follow the DEF definition of both event-source and event-target
nodes.
Warning: strongly typed event checking means that data type (SFInt32, MFVec3f, etc.) must
match identically for both event-source and event-target fields.
Warning: event-source fields can have accessType outputOnly or inputOutput, while event-target
nodes can have accessType inputOnly or inputOutput.
Hint: 10-Step Animation Design Process https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation/Chapter07-EventAnimationInterpolation.10StepAnimationDesignProcess.pdf
Hint: event tracing supports animation debugging https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation/Chapter07-EventAnimationInterpolation-EventTracing.pdf
Hint: X3D Architecture 7.2.5.7 ROUTE statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#ROUTEStatement
Hint: Fan-in occurs when two or more routes have the same destination field. All events
are considered to have been received simultaneously; therefore, the order in which
they are processed is not considered relevant.
Hint: Fan-out occurs when one field is the source for more than one route. This results
in sending any event generated by the field along all routes. All events are considered
to have been sent simultaneously; therefore, the order in which they are processed
is not considered relevant.
Hint: X3D Architecture 4.4.8.2 Routes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Routes
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 |
| fromNode |
[fromNode type IDREF #REQUIRED]
fromNode is the DEF name of the node originating an event. |
| fromField |
[fromField type NMTOKEN #REQUIRED]
fromField is the field name in the source node which is originating an event.
Hint: if (and only if) corresponding field has accessType inputOutput, author has option
to append "_changed" suffix to field name - both forms are functionally equivalent.
Warning: do not define an event connection using DEF, USE, class or containerField as literal
values, since they are not fields in a node that can be modified by events at run
time.
Warning: if corresponding field has accessType outputOnly or inputOnly, do not modify the
set_ prefix or the _changed suffix on the field name.
Hint: X3D Architecture 4.4.2.2 Field Semantics https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#FieldSemantics
Hint: X3D Compressed Binary Encoding, 4.2.3 X3D Canonical Form https://www.web3d.org/documents/specifications/19776-3/V3.3/Part03/concepts.html#X3DCanonicalForm |
| toNode |
[toNode type IDREF #REQUIRED]
toNode is the DEF name of the destination node receiving an event. |
| toField |
[toField type NMTOKEN #REQUIRED]
toField is the field name in the destination node which is receiving an event.
Hint: if (and only if) corresponding field has accessType inputOutput, author has option
to prepend "set_" prefix to field name - both forms are functionally equivalent.
Warning: do not define an event connection using DEF, USE, class or containerField as literal
values, since they are not fields in a node that can be modified by events at run
time.
Warning: if corresponding field has accessType outputOnly or inputOnly, do not modify the
set_ prefix or the _changed suffix on the field name.
Hint: X3D Architecture 4.4.2.2 Field Semantics https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#FieldSemantics
Hint: X3D Compressed Binary Encoding, 4.2.3 X3D Canonical Form https://www.web3d.org/documents/specifications/19776-3/V3.3/Part03/concepts.html#X3DCanonicalForm |
| 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 |
|
ScalarChaser |
(X3D version 3.2 or later) [inherits X3DChaserNode]
ScalarChaser generates a series of single floating-point values that progressively
change from initial value to destination value.
Hint: ROUTE value_changed output events to an interpolator node's set_fraction field,
for example. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 SFFloat CDATA "0"]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type SFFloat CDATA "0"]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type SFFloat 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 SFFloat 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 SFFloat 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 |
|
ScalarDamper |
(X3D version 3.3 or later) [inherits X3DDamperNode]
ScalarDamper generates a series of floating-point values that progressively change
from initial value to destination value.
Hint: ROUTE value_changed output events to an interpolator node's set_fraction field,
for example. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 SFFloat CDATA "0"]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type SFFloat CDATA "0"]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type SFFloat 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 SFFloat 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 SFFloat 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 |
|
ScalarInterpolator |
[inherits X3DInterpolatorNode]
ScalarInterpolator generates piecewise-linear SFFloat values. Authors can ROUTE
value_changed output events to other SFFloat fields.
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/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 MFFloat 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 SFFloat 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 |
Scene |
[X3D statement]
Scene is the root element that contains an X3D scene graph, appearing after the
head of an X3D model. Add nodes, statements and comments to build an X3D model. Only
one Scene root element is allowed per X3D file.
Hint: Scene can contain regular children nodes, Metadata* nodes and LayerSet as top-level
root nodes.
Hint: Scene is implicit, and not explicitly defined, in VRML97 and ClassicVRML encodings.
Hint: the Scene statement cannot have a DEF since it is not a node, cannot be re-USEd,
and cannot receive or send events.
Hint: Scene nodes for Inline models report identical values as top-most root of the contained
model.
Warning: player support for attribute fields in this node is not defined.
Warning: Scene is a child of X3D statement, and must follow the (optional) head statement.
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DNode]
Scene can contain nodes, statements and comments. |
| 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 |
|
ScreenFontStyle |
(X3D version 3.2 or later) [inherits X3DFontStyleNode]
ScreenFontStyle is an X3DFontStyleNode defines the size, family, justification,
and other styles used within a screen layout. ScreenFontStyle renders text so that
it appears identical to typical 2D applications by specifying pointSize in points
(as in 2D document layout) rather than size in meters. Each glyph of text is rendered
as a quadrilateral with a texture applied.
Hint: first add a Text node as a parent.
Hint: Wikipedia https://en.wikipedia.org/wiki/Font
Hint: Wikipedia https://en.wikipedia.org/wiki/Typeface |
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. |
| family |
[family accessType inputOutput, type MFString CDATA ( SERIF|SANS|TYPEWRITER ) "SERIF"]
Array of quoted font family names in preference order, browsers use the first supported
family.
Hint: example family array might be "Times" "SERIF"
Warning: font family support often varies.
Hint: values with guaranteed support include "SERIF" "SANS" "TYPEWRITER".
Hint: SERIF and SANS are variable-width fonts (for example, Times Roman and Arial).
Hint: TYPEWRITER is a fixed-width font (for example, Courier).
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks".
Hint: see 15.2.2.2 Font family and style https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Fontfamilyandstyle for details.
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| style |
[style accessType inputOutput, type SFString CDATA ( PLAIN|BOLD|ITALIC|BOLDITALIC ) PLAIN]
Pick one of four values for text style (PLAIN|BOLD|ITALIC|BOLDITALIC).
Warning: overloaded name for CSS style attribute.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values.
Hint: see 15.2.2.2 Font family and style https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Fontfamilyandstyle for details.
Hint: overlapping functionality with CSS style attribute provides a "best of both worlds"
approach. The style attribute provides an inline block of CSS source for element styling,
reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
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 |
| justify |
[justify accessType inputOutput, type MFString CDATA ( BEGIN|END|FIRST|MIDDLE ) "BEGIN" or "BEGIN" "END"]
The justify field determines horizontal and vertical alignment of text layout, relative
to the origin of the object coordinate system.
Hint: preferred value is usually justify=' "MIDDLE" "MIDDLE" ' for centered justification
horizontally and vertically.
Warning: exactly two string values are provided for major and minor axis alignment.
Warning: do not use illegal values such as LEFT RIGHT TOP BOTTOM or CENTER.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks".
Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| pointSize |
[pointSize accessType inputOutput, type SFFloat CDATA "12.0"] (0,+β)
pointSize field specifies the size of text in points. Nominal height (in local coordinate
system) of text glyphs, also sets default spacing between adjacent lines of text.
Hint: pointSize replaces the size field of the FontStyle node.
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| spacing |
[spacing accessType inputOutput, type SFFloat CDATA "1.0"] [0,+β)
Adjustment factor for line spacing between adjacent lines of text.
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| language |
[language accessType inputOutput, type SFString CDATA #IMPLIED]
Language codes consist of a primary code and a (possibly empty) series of subcodes.
[ language-code = primary-code ( "-" subcode )* ] Two-letter primary codes are reserved
for language abbreviations. Two-letter primary codes include en (English), fr (French),
de (German), it (Italian), nl (Dutch), el (Greek), es (Spanish), pt (Portuguese),
ar (Arabic), he (Hebrew), ru (Russian), zh (Chinese), ja (Japanese), hi (Hindi), ur
(Urdu), and sa (Sanskrit). Any two-letter subcode is understood to be a country code.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values.
Hint: see ISO639.2 Codes for the Representation of Names of Languages http://www.loc.gov/standards/iso639-2/php/code_list.php
Hint: see RFC3066 Tags for the Identification of Languages https://tools.ietf.org/html/rfc3066
Hint: see ISO3166 or http://xml.coverpages.org/languageIdentifiers.html
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| horizontal |
[horizontal accessType inputOutput, type SFBool (true|false) "true"]
Whether text direction is horizontal (true) or vertical (false).
Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| leftToRight |
[leftToRight accessType inputOutput, type SFBool (true|false) "true"]
Whether text direction is left-to-right (true) or right-to-left (false).
Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| topToBottom |
[topToBottom accessType inputOutput, type SFBool (true|false) "true"]
Whether text direction is top-to-bottom (true) or bottom-to-top (false).
Hint: see 15.2.2.3 Direction and justification https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html#Directionandjustification for details.
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: accessType relaxed to inputOutput in order to support animation and user accessibility.
|
| containerField |
[containerField type NMTOKEN "fontStyle"]
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 |
| |
accessType and type Credits and Translations X3D Resources |
|
ScreenGroup |
(X3D version 3.2 or later) [inherits X3DGroupingNode, implements X3DVisibleObject]
ScreenGroup is a Grouping node that can contain most nodes. ScreenGroup modifies
the screen scale in such a way that one unit is equal to one pixel in both the horizontal
and vertical directions.
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. |
| 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 |
|
Script |
[inherits X3DScriptNode]
Script contains author-programmed event behaviors for a scene.
Define the script input-output event interface by including <field/> elements.
Scripting code is embedded in a child CDATA node or (deprecated) in the url field.
Optionally supported programming languages are ECMAScript (JavaScript) and Java (via
url to a myNode.class file).
Hint: insert an XML Character Data (CDATA) block within the Script node to contain source
code embedded within an X3D scene, avoiding the need for escape characters.
Hint: a contained XML Character Data (CDATA) block for source code protects whitespace,
line breaks, and literal characters (such as & for ampersand character, < for less-than-sign
character, and > for greater-than-sign character) from unintended escape-character
modifications by XML parsers.
Warning: strict order is required for contained constructs: first field declarations (if
any), then IS/connect statements (if any), and finally CDATA source-code block.
Hint: X3D Scene Authoring Hints, Scripts https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scripts
Hint: apply containerField='watchList' when parent node is LoadSensor.ECMAScript-262 specification
http://www.ecma-international.org/publications/standards/Ecma-262.htm
Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field
without escape characters, equivalent to last entry in the url list, when using other
API codebases and file encodings. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| field |
[X3D statement field]
Include a field statement for each field declaration in this Script node.
Warning: to aid portability and avoid unintended overloading of variable references, it is
good practice for X3D Script authors to avoid the use of variables with global scope.
|
| 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: DEF name is needed or else ROUTEs cannot connect Script node interfaces.
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). |
| 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. |
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
List of address links for runnable script files.
Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field
without escape characters, equivalent to last entry in the url list, when using other
API codebases and file encodings.
Hint: browsers are not required to support any particular scripting language, but ECMAScript
(JavaScript) is widely supported.
Hint: equivalent script code written in multiple programming languages can be provided
for portability, the first runnable version is chosen at run time.
Hint: X3D Scene Authoring Hints, Scripts https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scripts
Warning: source code can be placed in url attribute but may be unparsable due to escaping
of special characters and elimination of line breaks (causing comments to nullify
follow-on code). Use contained CDATA section instead for embedding source code.
Hint: if both url field and CDATA section are provided simultaneously, the url field is
processed first. This approach allows utilization of update modifications or live
queries in external scripts, while still providing reliable script source as a fallback
alternative within the model itself.
Hint: X3D XML Encoding, 4.3.13 Encapsulating Script node code https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#EncapsulatingScriptNodeCode
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 |
| directOutput |
[directOutput accessType initializeOnly, type SFBool (true|false) "false"]
Set directOutput true if Script has field reference(s) of type SFNode/MFNode, and
also uses direct access to modify attributes of a referenced node in the Scene.
Hint: set directOutput true if Script dynamically establishes or breaks ROUTEs.
Hint: directOutput is a browser hint to avoid overoptimizing referenced nodes, since a
Script might directly change attribute values in referenced SFNode/MFNode fields,
without a ROUTE connecting output events.
Hint: directOutput false means Script cannot modify referenced nodes or change ROUTEs.
|
| mustEvaluate |
[mustEvaluate accessType initializeOnly, type SFBool (true|false) "false"]
If mustEvaluate false, then the X3D player may delay sending input events to Script
until output events are needed. If mustEvaluate true, then Script must receive input
events immediately without any event-aggregation delays.
Hint: set mustEvaluate true when sending/receiving values via the network. |
| 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 |
SegmentedVolumeData |
(X3D version 3.3 or later) [inherits X3DVolumeDataNode]
SegmentedVolumeData displays a segmented voxel dataset with different RenderStyle
nodes.
Hint: SegmentedVolumeData can contain a single ComposedTexture3D, ImageTexture3D or PixelTexture3D
node with containerField='segmentIdentifiers' and another with containerField='voxels'.
Hint: SegmentedVolumeData can contain multiple RenderStyle nodes.
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 |
| renderStyle |
[renderStyle accessType inputOutput, type MFNode array, empty list] [X3DVolumeRenderStyleNode]
Multiple contained X3DVolumeRenderStyleNode nodes corresponding to each isosurface
that define specific rendering technique for this volumetric object.
Hint:
Warning: if not defined, no default renderStryle is defined. |
| segmentEnabled |
[segmentEnabled accessType inputOutput, type MFBool CDATA , #IMPLIED]
Array of boolean values that indicates whether to draw each segment, with indices
corresponding to the segment identifier.
Hint: if a segment index is found greater than the array length, it shall be rendered.
|
| segmentIdentifiers |
[segmentIdentifiers accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture3DNode]
Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D)
holds component texture that provides corresponding segment identifier.
Hint: if more than one color component is contained, only initial color component defines
the segment identifier.
Warning: if segmentIdentifiers texture is not identical in size to the main voxels, it shall
be ignored. |
| voxels |
[voxels accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture3DNode]
Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D)
that provides raw voxel information utilized by corresponding rendering styles. Any
number of color components (1-4) may be defined. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| dimensions |
[dimensions accessType inputOutput, type SFVec3f CDATA "1 1 1"]
Actual-size X-Y-Z dimensions of volume data in local coordinate system. |
| 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 |
|
ShadedVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
ShadedVolumeStyle applies Blinn-Phong illumination model to volume rendering.
Hint: ShadedVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals'
and a single Material node.
Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='3'/>
or level='4' to include shadows. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| material |
[material accessType inputOutput, type SFNode singleton, NULL node] [X3DMaterialNode]
Colour and opacity is determined based on whether a value has been specified for
the material field. |
| 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. |
| lighting |
[lighting accessType inputOutput, type SFBool (true|false) "false"]
Whether rendering calculates and applies shading effects to visual output. |
| shadows |
[shadows accessType inputOutput, type SFBool (true|false) "false"]
Whether rendering calculates and applies shadows to visual output (using global
illumination model). |
| phaseFunction |
[phaseFunction accessType inputOutput, type SFString CDATA ( NONE|Henyey-Greenstein ) Henyey-Greenstein]
define scattering model for implementations using global illumination (NONE or Henyey-Greenstein
phase function).#10;
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| 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 |
|
ShaderPart |
(X3D version 3.1 or later) [inherits X3DNode, implements X3DUrlObject]
ShaderPart defines the source for a portion of source code used by a ComposedShader
node.
The source is not required to be a complete shader for all of the vertex/fragment
processing.
Hint: ShaderPart can contain a CDATA block of plain-text source code.
Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field
without escape characters, equivalent to last entry in the url list, when using other
API codebases and file encodings.
Warning: ShaderPart contains no field declarations.
Hint: insert an XML Character Data (CDATA) block within the Script node to contain source
code embedded within an X3D scene, avoiding the need for escape characters.
Hint: a contained XML Character Data (CDATA) block for source code protects whitespace,
line breaks, and literal characters (such as & for ampersand character, < for less-than-sign
character, and > for greater-than-sign character) from unintended escape-character
modifications by XML parsers.
Warning: strict order is required for contained constructs: first field declarations (if
any), then IS/connect statements (if any), and finally CDATA source-code block.
Hint: ShaderPart subprograms are written in the same language, which is specified in the
parent ComposedShader node.
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). |
| 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. |
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Location and filename of shader. Multiple locations are more reliable, and including
a Web address lets e-mail attachments work.
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
Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field
without escape characters, equivalent to last entry in the url list, when using other
API codebases and file encodings. |
| type |
[type accessType initializeOnly, type SFString CDATA (VERTEX|FRAGMENT) VERTEX]
type indicates whether this ShaderProgram is a vertex or fragment (pixel) shader.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| containerField |
[containerField type NMTOKEN (parts|watchList) "parts"]
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 |
|
ShaderProgram |
(X3D version 3.1 or later) [inherits X3DNode, implements X3DUrlObject, X3DProgrammableShaderObject]
ShaderProgram is contained by ProgramShader and provides the source and interface
to a self-contained program that occupies one part of the rendering process:
either a vertex or fragment shader.
Hint: ShaderProgram contains field declarations and then corresponding IS/connect statements
(if any).
Hint: insert an XML Character Data (CDATA) block within the Script node to contain source
code embedded within an X3D scene, avoiding the need for escape characters.
Hint: a contained XML Character Data (CDATA) block for source code protects whitespace,
line breaks, and literal characters (such as & for ampersand character, < for less-than-sign
character, and > for greater-than-sign character) from unintended escape-character
modifications by XML parsers.
Warning: strict order is required for contained constructs: first field declarations (if
any), then IS/connect statements (if any), and finally CDATA source-code block.
Hint: when parent node is LoadSensor, apply containerField='children' (X3Dv4) or containerField='watchList'
(X3Dv3). https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field
without escape characters, equivalent to last entry in the url list, when using other
API codebases and file encodings. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| field |
[X3D statement field]
Include a field statement for each field declaration in the ShaderProgram node.
|
| 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). |
| 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. |
| url |
[url accessType inputOutput, type MFString CDATA #IMPLIED]
Location and filename of shader. Multiple locations are more reliable, and including
a Web address lets e-mail attachments work.
Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field
without escape characters, equivalent to last entry in the url list, when using other
API codebases and file encodings.
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 |
| type |
[type accessType initializeOnly, type SFString CDATA (VERTEX|FRAGMENT) VERTEX]
type indicates whether this ShaderProgram is a vertex or fragment (pixel) shader.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| containerField |
[containerField type NMTOKEN (programs|watchList) "programs"]
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 |
|
Shape |
[inherits X3DShapeNode, implements X3DVisibleObject]
Shape can appear under any grouping node.
Shape can contain an Appearance node and a geometry node (for example one of the primitives
Box Cone Cylinder Sphere Text, one of ElevationGrid Extrusion IndexedFaceSet IndexedLineSet
LineSet PointSet, or one of the other geometry nodes).
Hint: Shape https://en.wikipedia.org/wiki/Shape
Hint: the Shape design pattern to collect appearance and geometry together is fundamentally
the same for many types of 3D graphics software and hardware.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content.
Hint: X3D Architecture 12.2.1 Shape nodes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shape.html#Shapenodes
Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/lighting.html#Lightingmodel
Hint: apply containerField='shape' if parent node is CADFace. |
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 |
| appearance |
[appearance accessType inputOutput, type SFNode singleton, NULL node] [X3DAppearanceNode]
Single contained Appearance node that can specify visual attributes (such as material,
texture, fillProperties and lineProperties) applied to corresponding geometry. |
| geometry |
[geometry accessType inputOutput, type SFNode singleton, NULL node] [X3DGeometryNode]
Single contained geometry node that is rendered according to corresponding appearance.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding
box position offset from origin of local coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization
of large detailed models, with a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/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.
|
| castShadow |
[castShadow accessType inputOutput, type SFBool (true|false) "true"]
castShadow defines whether this Shape casts shadows as produced by lighting nodes.
Hint: if the visible field is FALSE, then the Shape does not cast any shadows.
Hint: if prior X3D3 content is loaded into an X3D4 model, then legacy Shape nodes have
shadows set to true. |
| 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|proxy|rootNode|shape|skin) "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 |
SignalPdu |
[inherits X3DNetworkSensorNode, implements X3DBoundedObject, X3DVisibleObject]
SignalPdu is a networked Protocol Data Unit (PDU) information node that communicates
the transmission of voice, audio or other data modeled in a simulation.
Hint: SignalPdu packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
Hint: Savage Developers Guide on DIS https://savage.nps.edu/Savage/developers.html#DIS
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
Warning: requires X3D profile='Full' or else include <component name='DIS' level='1'/> |
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 the sensor node. |
| whichGeometry |
[whichGeometry accessType inputOutput, type SFInt32 CDATA "1"]
Select geometry to render: -1 for no geometry, 0 for text trace, 1 for default geometry,
(optional) higher values to render different states. |
| 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.
|
| 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). |
| 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. |
| entityID |
[entityID accessType inputOutput, type SFInt32 CDATA "0"]
EntityID unique ID for entity within that application. |
| applicationID |
[applicationID accessType inputOutput, type SFInt32 CDATA "0"]
Each simulation application that can respond to simulation management PDUs needs
to have a unique applicationID. |
| siteID |
[siteID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise siteID of the participating LAN or organization. |
| readInterval |
[readInterval accessType inputOutput, type SFTime CDATA "0.1"] [0,+β)
Seconds between read updates, 0 means no reading.
Hint: readInterval is a nonnegative SFTime duration interval, not an absolute clock time.
|
| writeInterval |
[writeInterval accessType inputOutput, type SFTime CDATA "1.0"] [0,+β)
Seconds between write updates, 0 means no writing (sending).
Hint: writeInterval is a nonnegative SFTime duration interval, not an absolute clock time.
|
| networkMode |
[networkMode accessType inputOutput, type SFString CDATA ( standAlone|networkReader|networkWriter ) standAlone]
Whether this entity is ignoring the network, sending DIS packets to the network,
or receiving DIS packets from the network. (1) standAlone: ignore network but still
respond to events in local scene. (2) networkReader: listen to network and read PDU
packets at readInterval, act as remotely linked copy of entity. (3) networkWriter:
send PDU packets to network at writeInterval, act as master entity. Default value
"standAlone" ensures that DIS network activation within a scene as networkReader or
networkWriter is intentional.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values.
Warning: network activity may have associated security issues. |
| isStandAlone |
[isStandAlone accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='local' (ignore network but still respond to local events).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isNetworkReader |
[isNetworkReader accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='remote' (listen to network as copy of remote entity).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isNetworkWriter |
[isNetworkWriter accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='master' (output to network as master entity at writeInterval).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| address |
[address accessType inputOutput, type SFString CDATA localhost]
Multicast network address, or else 'localhost'.
Example: 224.2.181.145. |
| port |
[port accessType inputOutput, type SFInt32 CDATA "0"]
Multicast network port, for example: 3000. |
| multicastRelayHost |
[multicastRelayHost accessType inputOutput, type SFString CDATA #IMPLIED]
Fallback server address if multicast not available locally. For example: track.nps.edu.
|
| multicastRelayPort |
[multicastRelayPort accessType inputOutput, type SFInt32 CDATA "0"]
Fallback server port if multicast not available locally. For example: 8010. |
| rtpHeaderExpected |
[rtpHeaderExpected accessType inputOutput, type SFBool (true|false) "false"]
Whether RTP headers are prepended to DIS PDUs. |
| isRtpHeaderHeard |
[isRtpHeaderHeard accessType outputOnly, type SFBool #FIXED ""]
Whether incoming DIS packets have an RTP header prepended.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
confirm whether there has been a recent network update.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| timestamp |
[timestamp accessType outputOnly, type SFTime CDATA #FIXED ""]
DIS timestamp in X3D units (value 0.0 matches 1 January 1970) in seconds.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| radioID |
[radioID accessType inputOutput, type SFInt32 CDATA "0"]
Identifies a particular radio within a given entity. |
| encodingScheme |
[encodingScheme accessType inputOutput, type SFInt32 CDATA "0"]
designates both Encoding Class and Encoding Type. Encoding Class enumerated value
(2 most significant bits): 0 = Encoded Voice; 1 = Raw Binary Data; 2 = Application-Specific
Data; 3 = Database Index. Encoding Type enumerated value (14 least significant bits):
1 = 8-bit mu-law; 2 = CVSD per MIL-STD-188-113; 3 = ADPCM per CCITT G.721; 4 = 16-bit
linear PCM; 5 = 8-bit linear PCM; 6 = Vector Quantization. |
| tdlType |
[tdlType accessType inputOutput, type SFInt32 CDATA "0"]
Tactical Data Link (TDL) type as an enumerated value when the Encoding Class is
voice, raw binary, application-specific, or database index representation of a TDL
message. |
| sampleRate |
[sampleRate accessType inputOutput, type SFInt32 CDATA "0"]
sampleRate gives either (1) sample rate in samples per second if Encoding Class
is encoded audio, or (2) data rate in bits per second for data transmissions. If Encoding
Class is database index, sampleRate is set to zero.
Hint: Wikipedia Nyquist frequency https://en.wikipedia.org/wiki/Nyquist_frequency |
| samples |
[samples accessType inputOutput, type SFInt32 CDATA "0"]
Number of samples in the PDU if the Encoding Class is encoded voice, otherwise the
field is set to zero. |
| dataLength |
[dataLength accessType inputOutput, type SFInt32 CDATA "0"]
number of bits of digital voice audio or digital data being sent in the Signal PDU.
If the Encoding Class is database index, then dataLength field is set to 96. |
| data |
[data accessType inputOutput, type MFInt32 CDATA #IMPLIED]
Holds audio or digital data conveyed by the radio transmission. Interpretation of
the field depends on values of encodingScheme and tdlType fields. |
| geoCoords |
(X3D version 3.3 or later) [geoCoords accessType inputOutput, type SFVec3d CDATA "0 0 0"]
Geographic location (specified in current geoSystem coordinates) for children geometry
(specified in relative coordinate system, in meters).
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'/>
|
| geoSystem |
(X3D version 3.3 or later) [geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| 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 |
SilhouetteEnhancementVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
SilhouetteEnhancementVolumeStyle specifies that volumetric data is rendered with
silhouette enhancement.
Hint: SilhouetteEnhancementVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals'
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. |
| silhouetteBoundaryOpacity |
[silhouetteBoundaryOpacity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
amount of the silhouette enhancement to use. |
| silhouetteRetainedOpacity |
[silhouetteRetainedOpacity accessType inputOutput, type SFFloat CDATA "1"] [0,1]
scaling of non-silhouette regions. |
| silhouetteSharpness |
[silhouetteSharpness accessType inputOutput, type SFFloat CDATA "0.5"] [0,+β)
power function to control sharpness of the silhouette. |
| 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 |
SingleAxisHingeJoint |
(X3D version 3.2 or later) [inherits X3DRigidJointNode]
SingleAxisHingeJoint has single axis about which to rotate, similar to a traditional
door hinge.
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. |
| axis |
[axis accessType inputOutput, type SFVec3f CDATA "0 1 0"]
axis defines vector of joint connection between body1 and body2. |
| forceOutput |
[forceOutput accessType inputOutput, type MFString CDATA "NONE"]
forceOutput controls which output fields are generated for the next frame. Values
are ALL, NONE, or exact names of output fields updated at start of next frame. |
| minAngle |
[minAngle accessType inputOutput, type SFFloat CDATA "-3.1416"] [-Ο,Ο]
minAngle is minimum rotation angle for hinge.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| maxAngle |
[maxAngle accessType inputOutput, type SFFloat CDATA "3.1416"] [-Ο,Ο]
maxAngle is maximum rotation angle for hinge.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| stopBounce |
[stopBounce accessType inputOutput, type SFFloat CDATA "0"] [0,1]
stopBounce is velocity factor for bounce back once stop point is reached.
Hint: 0 means no bounce, 1 means return velocity matches. |
| stopErrorCorrection |
[stopErrorCorrection accessType inputOutput, type SFFloat CDATA "0.8"] [0,1]
stopErrorCorrection is fraction of error correction performed during time step once
stop point is reached.
Hint: 0 means no error correction, 1 means all error corrected in single step. |
| 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 |
|
SliderJoint |
(X3D version 3.2 or later) [inherits X3DRigidJointNode]
SliderJoint constrains all movement between body1 and body2 along a single axis.
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.do NOT include DEF (or any other attribute values) when using
a USE attribute! |
| axis |
[axis accessType inputOutput, type SFVec3f CDATA "0 1 0"] [0,1]
axis is normalized vector specifying direction of motion. |
| 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. |
| minSeparation |
[minSeparation accessType inputOutput, type SFFloat CDATA "0"]
minSeparation is minimum separation distance between the two bodies.
Hint: if (minSeparation is less than maxSeparation) then no stop is effective. |
| maxSeparation |
[maxSeparation accessType inputOutput, type SFFloat CDATA "1"]
maxSeparation is maximum separation distance between the two bodies.
Hint: if (minSeparation is less than maxSeparation) then no stop is effective. |
| sliderForce |
[sliderForce accessType inputOutput, type SFFloat CDATA "0"] [-β,β]
sliderForce value is used to apply a force (specified in force base units) along
the axis of the slider in equal and opposite directions to the two bodies. A positive
value applies a force such that the two bodies accelerate away from each other, while
a negative value applies a force such that the two bodies accelerate toward each other.
|
| stopBounce |
[stopBounce accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stopBounce is velocity factor for bounce back once stop point is reached.
Hint: 0 means no bounce, 1 means return velocity matches. |
| stopErrorCorrection |
[stopErrorCorrection accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stopErrorCorrection is fraction of error correction performed during time step once
stop point is reached.
Hint: 0 means no error correction, 1 means all error corrected in single step. |
| separation |
[separation accessType outputOnly, type SFFloat CDATA]
separation indicates final separation distance between the two bodies.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| separationRate |
[separationRate accessType outputOnly, type SFFloat CDATA]
separationRate indicates change in separation distance over time between the two
bodies.
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 |
Sound |
[inherits X3DSoundNode]
The Sound node controls the 3D spatialization of sound playback by a child AudioClip
or MovieTexture node. Sound intensity includes stereo support, varying according to
user location and view direction in the scene.
Hint: if the audio source is stereo or multi-channel, channel separation is retained during
playback.
Warning: while providing sounds on the ground plane, ensure that the audible auralization
volume is sufficiently elevated to match avatar height.
Hint: X3D Sound component Figure 16.2 Sound Node Geometry, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/sound.html#f-Soundnodegeometry
Hint: X3D Scene Authoring Hints:Audio https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Audio
Hint: Wikipedia 3D sound localization https://en.wikipedia.org/wiki/3D_sound_localization |
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 |
| source |
[source accessType inputOutput, type SFNode singleton, NULL node] [X3DSoundSourceNode]
sound source for the Sound node, either an AudioClip node or a MovieTexture node.
Warning: if source field is not specified, the Sound node does not emit audio. |
| 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 this node.
Hint: include space characters since a description is not a DEF identifier. Write short
phrases that make descriptions clear and readable.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| location |
[location accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position of sound ellipsoid center, relative to local coordinate system.
Hint: improve audibility by setting location='0 1.6 0' so that center height of sound
ellipsoid matches typical NavigationInfo avatarSize height. |
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 0 1"]
direction of sound axis, relative to local coordinate system. |
| intensity |
[intensity accessType inputOutput, type SFFloat CDATA "1"]
Factor [0,1] adjusting loudness (decibels) of emitted sound. |
| minFront |
[minFront accessType inputOutput, type SFFloat CDATA "1"]
Inner (full loudness) ellipsoid distance along front direction.
Warning: ensure minFront <= maxFront. |
| minBack |
[minBack accessType inputOutput, type SFFloat CDATA "1"]
Inner (full loudness) ellipsoid distance along back direction.
Warning: ensure minBack <= maxBack. |
| maxFront |
[maxFront accessType inputOutput, type SFFloat CDATA "10"]
Outer (zero loudness)ellipsoid distance along front direction.
Warning: ensure minFront <= maxFront. |
| maxBack |
[maxBack accessType inputOutput, type SFFloat CDATA "10"]
Outer (zero loudness)ellipsoid distance along back direction.
Warning: ensure minBack <= maxBack. |
| priority |
[priority accessType inputOutput, type SFFloat CDATA "0"]
Player hint [0,1] if needed to choose which sounds to play. |
| spatialize |
[spatialize accessType initializeOnly, type SFBool (true|false) "true"]
Whether to spatialize sound playback relative to viewer.
Hint: only effective within the auralization volume. |
| 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 |
|
SpatialSound |
[inherits X3DSoundNode]
The SpatialSound node controls the 3D spatialization of sound playback by a child
AudioClip or MovieTexture node. Sound intensity includes stereo support, varying according
to user location and view direction in the scene.
Hint: if the audio source is stereo or multi-channel, channel separation is retained during
playback.
Warning: while providing sounds on the ground plane, ensure that the audible auralization
volume is sufficiently elevated to match avatar height.
Hint: X3D Sound component Figure 16.2 Sound Node Geometry, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/sound.html#f-Soundnodegeometry
Hint: W3C Web Audio API, PannerNode Interface https://www.w3.org/TR/webaudio/#pannernode
Hint: X3D Scene Authoring Hints:Audio https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Audio
Hint: Wikipedia 3D sound localization https://en.wikipedia.org/wiki/3D_sound_localization |
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. |
| coneInnerAngle |
[coneInnerAngle accessType inputOutput, type SFFloat CDATA "6.2832"] [0,2Ο]
coneInnerAngle is centered along direction and defines the inner conical volume,
inside of which no source gain reduction occurs.
Hint: coneOuterAngle value is greater than or equal to coneInnerAngle.
Hint: X3D4 Architecture Figure 16.3, SpatialSound Panning Gain Relationships https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/sound.html#f-AudioPannerListenerRelationships |
| coneOuterAngle |
[coneOuterAngle accessType inputOutput, type SFFloat CDATA "6.2832"] [0,2Ο]
coneOuterAngle is centered along direction and defines an outer conical volume,
within which the sound gain decreases linearly from full gain to coneOuterGain. Outside
of coneOuterAngle, gain equals coneOuterGain.
Hint: coneOuterAngle value is greater than or equal to coneInnerAngle.
Hint: X3D4 Architecture Figure 16.3, SpatialSound Panning Gain Relationships https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/sound.html#f-AudioPannerListenerRelationships |
| coneOuterGain |
[coneOuterGain accessType inputOutput, type SFFloat CDATA "0"] (-β,+β)
coneOuterGain is minimum gain value found outside coneOuterAngle. |
| 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). |
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 0 1"]
direction of sound axis, relative to local coordinate system. |
| distanceModel |
[distanceModel accessType inputOutput, type SFString CDATA ( LINEAR|INVERSE|EXPONENTIAL ) INVERSE]
distanceModel determines how field specifies which algorithm to use for sound attenuation,
corresponding to distance between an audio source and a listener, as it moves away
from the listener.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#enumdef-distancemodeltype |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| dopplerEnabled |
[dopplerEnabled accessType inputOutput, type SFBool (true|false) "false"]
dopplerEnabled enables/disables whether real-time Doppler effects (due to relation
motion between sources and listeners) are computed by browser between virtual sound
sources and active listening locations, then applied to received frequency at active
listening locations.
Hint: functional support requires player support for Sound component level 3.
Hint: Wikipedia Doppler effect https://en.wikipedia.org/wiki/Doppler_effect |
| enableHRTF |
[enableHRTF accessType inputOutput, type SFBool (true|false) "false"]
enableHRTF enables/disables Head Related Transfer Function (HRTF) auralization,
if available. SpatialSound enabledHRTF=true corresponds to panningModelType HRTF,
enabledHRTF=false corresponds to panningModelType equalpower.
Hint: W3C Audio API https://www.w3.org/TR/webaudio/#enumdef-panningmodeltype
Hint: Wikipedia HRTF https://en.wikipedia.org/wiki/3D_sound_localization#Head-related_Transfer_Function_(HRTF) |
| 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. |
| intensity |
[intensity accessType inputOutput, type SFFloat CDATA "1"]
Factor [0,1] adjusting loudness (decibels) of emitted sound. |
| location |
[location accessType inputOutput, type SFVec3f CDATA "0 0 0"] [0,+β)
Position of sound ellipsoid center, relative to local coordinate system.
Hint: improve audibility by setting location='0 1.6 0' so that center height of sound
ellipsoid matches typical NavigationInfo avatarSize height. |
| maxDistance |
[maxDistance accessType inputOutput, type SFFloat CDATA "10000"] [0,+β)
maxDistance is the maximum distance where sound is renderable between source and
listener, after which no reduction in sound volume occurs. |
| referenceDistance |
[referenceDistance accessType inputOutput, type SFFloat CDATA "1"] [0,+β)
referenceDistance for reducing volume as source moves further from the listener.
For distances less than this value, volume is not reduced.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-pannernode-refdistance |
| rolloffFactor |
[rolloffFactor accessType inputOutput, type SFFloat CDATA "1"] [0,+β)
rolloffFactor indicates how quickly volume is reduced as source moves further from
listener.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-pannernode-rollofffactor |
| priority |
[priority accessType inputOutput, type SFFloat CDATA "0"]
Player hint [0,1] if needed to choose which sounds to play. |
| spatialize |
[spatialize accessType initializeOnly, type SFBool (true|false) "true"]
Whether to spatialize sound playback relative to viewer.
Hint: only effective within the auralization volume. |
| 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 |
|
Sphere |
[inherits X3DGeometryNode]
Sphere is a geometry node, representing a perfectly round geometrical object that
is the surface of a completely round ball.
Hint: Sphere https://en.wikipedia.org/wiki/Sphere
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. |
| radius |
[radius accessType initializeOnly, type SFFloat CDATA "1"] (0,+β)
Size in meters.
Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial
creation, 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 |
SphereSensor |
[inherits X3DDragSensorNode]
SphereSensor converts pointing device motion into a spherical rotation
about the origin of the local coordinate system.
Hint: this sensor detects user interactions affecting peer nodes and their child geometry.
Hint: add semi-transparent surrounding geometry to see the effect of the sensor.
Hint: X3D Architecture 20.2.1 Overview of pointing device sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html#OverviewOfPointingDeviceSensors
Hint: X3D Architecture 20.2.2 Drag sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html#DragSensors
Hint: X3D Architecture 20.2.3 Activating and manipulating pointing device sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html#Activatingandmanipulating |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 this node.
Hint: include space characters since a description is not a DEF identifier. Write short
phrases that make descriptions clear and readable.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| autoOffset |
[autoOffset accessType inputOutput, type SFBool (true|false) "true"]
Determines whether previous offset values are remembered/accumulated. |
| offset |
[offset accessType inputOutput, type SFRotation CDATA "0 1 0 0"]
Sends event and remembers last value sensed.
Warning: ROUTE connecting rotation_changed to set_offset creates a self-reinforcing positive
feedback loop and results in unmanageable response. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
Select geometry by activating the pointing device (for example, clicking the mouse)
to generate isActive events. Output event isActive=true is sent when geometry is selected
(for example, when primary mouse button is pressed), output event isActive=false is
sent when geometry is deselected (for example, when primary mouse button is released).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isOver |
[isOver accessType outputOnly, type SFBool #FIXED ""]
Hover over geometry by aiming the mouse (or pointing device) to generate isOver
events. Sensor sends output event isOver=true event when pointing device moves over
sensor's geometry, and later sends output event isOver=false event when pointing device
moves off.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| rotation_changed |
[rotation_changed accessType outputOnly, type SFRotation CDATA #FIXED ""]
rotation_changed events equal sum of relative bearing changes plus offset value.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| trackPoint_changed |
[trackPoint_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
trackPoint_changed events give intersection point of bearing with sensor's virtual
geometry.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events.
Warning: trackPoint_changed events represent unclamped intersection points on plane surface.
Browsers can interpret drags off of the surface in various ways. Note that translation_changed
events are clamped by minPosition/maxPosition and thus may be preferable. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
SplinePositionInterpolator |
(X3D version 3.2 or later) [inherits X3DInterpolatorNode]
SplinePositionInterpolator performs non-linear interpolation among paired lists
of 3-tuple values and velocities to produce an SFVec3f value_changed output event.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='4'/>
|
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. |
| closed |
[closed accessType inputOutput, type SFBool (true|false) "false"]
Whether or not the curve is closed (i.e. matching end values), with continuous velocity
vectors as the interpolator transitions from the last key to the first key.
Warning: if velocity vectors at first and last keys are specified, the closed field is ignored.
Warning: if keyValues at first and last key are not identical, the closed field is ignored.
|
| key |
[key accessType inputOutput, type MFFloat CDATA #IMPLIED]
Definition parameters for nonlinear-interpolation function time intervals, listed
in non-decreasing order and corresponding to keyValue, keyVelocity array values.
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 MFVec3f CDATA #IMPLIED]
Output values for nonlinear interpolation, each corresponding to an input-fraction
value in the key array.
Warning: number of keys must match number of keyValues! |
| keyVelocity |
[keyVelocity accessType inputOutput, type MFVec3f CDATA #IMPLIED]
Output values for nonlinear interpolation, each corresponding to an input-fraction
value in the key array.
Warning: number of keys must match number of keyVelocity values! |
| normalizeVelocity |
[normalizeVelocity accessType inputOutput, type SFBool (true|false) "false"]
normalizeVelocity field specifies whether the velocity vectors are normalized to
produce smooth speed transitions, or transformed into tangency vectors.
Hint: X3D 19.2.3 Non-linear interpolation https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/interpolators.html#NonlinearInterpolation |
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input key for corresponding use of keyValue, keyVelocity values
for output computation.
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 SFVec3f CDATA #FIXED ""]
Nonlinearly interpolated output value computed by using current time fraction along
with corresponding key, keyValue and keyVelocity values.
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 |
SplinePositionInterpolator2D |
(X3D version 3.2 or later) [inherits X3DInterpolatorNode]
SplinePositionInterpolator2D performs non-linear interpolation among paired lists
of 2-tuple values and velocities to produce an SFVec2f value_changed output event.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='4'/>
|
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. |
| closed |
[closed accessType inputOutput, type SFBool (true|false) "false"]
Whether or not the curve is closed (i.e. matching end values), with continuous velocity
vectors as the interpolator transitions from the last key to the first key.
Warning: if velocity vectors at first and last keys are specified, the closed field is ignored.
Warning: if keyValues at first and last key are not identical, the closed field is ignored.
|
| key |
[key accessType inputOutput, type MFFloat CDATA #IMPLIED]
Definition parameters for nonlinear-interpolation function time intervals, listed
in non-decreasing order and corresponding to keyValue, keyVelocity array values.
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 MFVec2f CDATA #IMPLIED]
Output values for nonlinear interpolation, each corresponding to an input-fraction
value in the key array.
Warning: number of keys must match number of keyValues! |
| keyVelocity |
[keyVelocity accessType inputOutput, type MFVec2f CDATA #IMPLIED]
Output values for nonlinear interpolation, each corresponding to an input-fraction
value in the key array.
Warning: number of keys must match number of keyVelocity values! |
| normalizeVelocity |
[normalizeVelocity accessType inputOutput, type SFBool (true|false) "false"]
normalizeVelocity field specifies whether the velocity vectors are normalized to
produce smooth speed transitions, or transformed into tangency vectors.
Hint: X3D 19.2.3 Non-linear interpolation https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/interpolators.html#NonlinearInterpolation |
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input key for corresponding use of keyValue, keyVelocity values
for output computation.
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 SFVec2f CDATA #FIXED ""]
Nonlinearly interpolated output value computed by using current time fraction along
with corresponding key, keyValue and keyVelocity values.
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 |
SplineScalarInterpolator |
(X3D version 3.2 or later) [inherits X3DInterpolatorNode]
SplineScalarInterpolator performs non-linear interpolation among paired lists of
float values and velocities to produce an SFFloat value_changed output event.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='4'/>
|
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. |
| closed |
[closed accessType inputOutput, type SFBool (true|false) "false"]
Whether or not the curve is closed (i.e. matching end values), with continuous velocity
vectors as the interpolator transitions from the last key to the first key.
Warning: if velocity vectors at first and last keys are specified, the closed field is ignored.
Warning: if keyValues at first and last key are not identical, the closed field is ignored.
|
| key |
[key accessType inputOutput, type MFFloat CDATA #IMPLIED]
Definition parameters for nonlinear-interpolation function time intervals, listed
in non-decreasing order and corresponding to keyValue, keyVelocity array values.
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 MFFloat CDATA #IMPLIED]
Output values for nonlinear interpolation, each corresponding to an input-fraction
value in the key array.
Warning: number of keys must match number of keyValues! |
| keyVelocity |
[keyVelocity accessType inputOutput, type MFFloat CDATA #IMPLIED]
Output values for nonlinear interpolation, each corresponding to an input-fraction
value in the key array.
Warning: number of keys must match number of keyVelocity values! |
| normalizeVelocity |
[normalizeVelocity accessType inputOutput, type SFBool (true|false) "false"]
normalizeVelocity field specifies whether the velocity vectors are normalized to
produce smooth speed transitions, or transformed into tangency vectors.
Hint: X3D 19.2.3 Non-linear interpolation https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/interpolators.html#NonlinearInterpolation |
| set_fraction |
[set_fraction accessType inputOnly, type SFFloat CDATA #FIXED ""]
set_fraction selects input key for corresponding use of keyValue, keyVelocity values
for output computation.
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 SFFloat CDATA #FIXED ""]
Nonlinearly interpolated output value computed by using current time fraction along
with corresponding key, keyValue and keyVelocity values.
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 |
SpotLight |
[inherits X3DLightNode]
SpotLight is a light source that illuminates geometry within a conical beam.
Lighting illuminates all geometry except lines and points. By default, light scope
only illuminates peer geometry and children nodes within the scene graph hierarchy.
Lights have no visible shape themselves and lighting effects continue through any
intermediate geometry.
Hint: the bound NavigationInfo controls whether headlight is enabled on/off. |
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. |
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables this light source. |
| color |
[color accessType inputOutput, type SFColor CDATA "1 1 1"] [0,1]
color of light, applied to colors of objects.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| location |
[location accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position of light relative to local coordinate system. |
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 0 -1"]
Orientation vector of light relative to local coordinate system. |
| intensity |
[intensity accessType inputOutput, type SFFloat CDATA "1"] [0,+β]
Brightness of direct emission from the light. |
| ambientIntensity |
[ambientIntensity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
Brightness of ambient (nondirectional background) emission from the light. |
| shadowIntensity |
[shadowIntensity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
shadowIntensity field defines how much light is obscured by shapes that cast shadows,
ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured,
full-intensity shadows). |
| shadows |
[shadows accessType inputOutput, type SFBool (true|false) "false"]
shadows field indicates whether or not this light casts a shadow behind illuminated
X3DShapeNode geometry. |
| attenuation |
[attenuation accessType inputOutput, type SFVec3f CDATA "1 0 0"]
Constant, linear-distance and squared-distance dropoff factors as radial distance
increases from the source.
Hint: attenuation = 1/max(attenuation[0] + attenuation[1] β¨― r + attenuation[2] β¨― r2 ,
1) |
| radius |
[radius accessType inputOutput, type SFFloat CDATA "100"]
Maximum effective distance of light relative to local light position, affected by
ancestor scaling. |
| beamWidth |
[beamWidth accessType inputOutput, type SFFloat CDATA "0.589049"] [0,1.570796]
Inner conical solid angle (in radians) where light source has uniform full intensity.
Hint: beamWidth is inner angle of full intensity, cutOffAngle is outer angle of zero intensity.
Therefore set beamWidth <= cutOffAngle.
Warning: if beamWidth > cutOffAngle, then beamWidth is reset to equal cutOffAngle.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| cutOffAngle |
[cutOffAngle accessType inputOutput, type SFFloat CDATA "1.570796"] [0,1.570796]
Outer conical solid angle (in radians) where light source intensity becomes zero.
Hint: beamWidth is inner angle of full intensity, cutOffAngle is outer angle of zero intensity.
Therefore set beamWidth <= cutOffAngle.
Warning: if beamWidth > cutOffAngle, then beamWidth is reset to equal cutOffAngle.
Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian |
| global |
(X3D version 3.1 or later) [global accessType inputOutput, type SFBool (true|false) "true"]
Global lights illuminate all objects within their volume of lighting influence.
Scoped lights only illuminate objects within the same transformation hierarchy.
Warning: DirectionalLight default global=false to limit scope and avoid inadvertently illuminating
every object in a large scene. PointLight and SpotLight default global=true since
their effects are each limited by maximum radius value. |
| containerField |
[containerField type NMTOKEN "children"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
SquadOrientationInterpolator |
(X3D version 3.2 or later) [inherits X3DInterpolatorNode]
SquadOrientationInterpolator performs non-linear interpolation among paired lists
of rotation values to produce an SFRotation value_changed output event.
Hint: Squad is an acronym for Spherical Cubic Interpolation.
Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='5'/>
|
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. |
| normalizeVelocity |
[normalizeVelocity accessType inputOutput, type SFBool (true|false) "false"]
normalizeVelocity field specifies whether the velocity vectors are normalized to
produce smooth speed transitions, or transformed into tangency vectors.
Hint: X3D 19.2.3 Non-linear interpolation https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/interpolators.html#NonlinearInterpolation |
| key |
[key accessType inputOutput, type MFFloat CDATA #IMPLIED]
Definition parameters for nonlinear-interpolation function time intervals, listed
in non-decreasing order and corresponding to keyValue, keyVelocity array values.
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 MFRotation CDATA #IMPLIED]
Output values for nonlinear interpolation, 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 use of keyValue, keyVelocity values
for output computation.
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 SFRotation CDATA #FIXED ""]
Nonlinearly interpolated output value computed by using current time fraction along
with corresponding key, keyValue and keyVelocity values.
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 |
|
StaticGroup |
[inherits X3DChildNode, implements X3DBoundedObject, X3DVisibleObject]
StaticGroup is a Grouping node that can contain most nodes. StaticGroup children
are guaranteed to not change, send events,
receive events, or include re-USE-able content.
This allows browser optimizations of contained-node content.
Hint: insert a Shape node before adding geometry or Appearance.
Warning: requires X3D profile='Full' or else include <component name='Grouping' 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 |
| 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.
Warning: StaticGroup does not support inputOnly MFNode fields addChildren or removeChildren.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| bboxCenter |
[bboxCenter accessType initializeOnly, type SFVec3f CDATA "0 0 0"]
Bounding box center accompanies bboxSize and provides an optional hint for bounding
box position offset from origin of local coordinate system.
Hint: precomputation and inclusion of bounding box information can speed up the initialization
of large detailed models, with a corresponding cost of increased file size.
Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/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 |
StreamAudioDestination |
[inherits X3DSoundDestinationNode]
StreamAudioDestination node represents the final audio destination via a media stream.
Warning: stream-identification parameters are not fully defined and subject to change.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#mediastreamaudiodestinationnode |
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 |
| streamIdentifier |
[streamIdentifier accessType inputOutput, type MFString CDATA #IMPLIED]
Stream identification TBD
Hint: W3C Media Capture and Streams https://www.w3.org/TR/mediacapture-streams |
| 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 |
|
StreamAudioSource |
[inherits X3DSoundSourceNode]
StreamAudioSource operates as an audio source whose media is received from a MediaStream
obtained using the WebRTC or Media Capture and Streams APIs. This media source might
originate from a remote microphone or sound-processing channed provided by a remote
peer on a WebRTC call.\.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#mediastreamaudiosourcenode |
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. |
| 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. |
| streamIdentifier |
[streamIdentifier accessType inputOutput, type MFString CDATA #IMPLIED]
Stream identification TBD
Hint: W3C Media Capture and Streams https://www.w3.org/TR/mediacapture-streams |
| 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 |
StringSensor |
[inherits X3DKeyDeviceSensorNode]
StringSensor generates events as the user presses keys on the keyboard. Browser
support includes the notion of "keyboard focus".
Hint: example scenes and authoring assets at https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter08UserInteractivity |
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. |
| 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. |
| deletionAllowed |
[deletionAllowed accessType inputOutput, type SFBool (true|false) "true"]
If deletionAllowed is true, then previously entered character in enteredText can
be removed. If deletionAllowed is false, then characters may only be added to the
string.
Hint: deletion key is typically defined by local system. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
Select geometry by activating the pointing device (for example, clicking the mouse)
to generate isActive events. Output event isActive=true is sent when geometry is selected
(for example, when primary mouse button is pressed), output event isActive=false is
sent when geometry is deselected (for example, when primary mouse button is released).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| enteredText |
[enteredText accessType outputOnly, type SFString CDATA #FIXED ""]
Events generated as character-producing keys are pressed on keyboard.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| finalText |
[finalText accessType outputOnly, type SFString CDATA #FIXED ""]
Events generated when sequence of keystrokes matches keys in terminationText string
when this condition occurs, enteredText is moved to finalText and enteredText is set
to empty string.
Hint: termination key is typically defined by local system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| 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 |
|
SurfaceEmitter |
(X3D version 3.2 or later) [inherits X3DParticleEmitterNode]
SurfaceEmitter generates particles from the surface of an object. New particles
are generated by first randomly choosing a face on the tessellated geometry and then
a random position on that face. Particles are generated with an initial direction
of the normal to that point (including any normal averaging due to normalPerVertex
and creaseAngle field settings).
Hint: ff surface is not solid (solid=false), randomly choose from which side of the surface
to emit, negating the normal direction when generating from the back side.
Warning: only valid geometry shall be used. |
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. |
| surface |
[surface accessType inputOutput, type SFNode singleton, NULL node] [X3DGeometryNode]
The geometry node provides geometry used as the emitting surface.
Hint: If the surface is indicated as not being solid (solid field set to false), randomly
choose from which side of the surface to emit, negating the normal direction when
generating from the back side.
Warning: only valid geometry shall be used. |
| mass |
[mass accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Basic mass of each particle, defined in mass base units (default is kilograms).
Hint: mass is needed if gravity or other force-related calculations are performed on a
per-particle basis.
Hint: https://en.wikipedia.org/wiki/Kilogram
Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates |
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables production of particles from this emitter node. If operating when
turned off, existing particles complete their rendering process. |
| speed |
[speed accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
Initial linear speed (default is m/s) imparted to all particles along their direction
of movement. |
| surfaceArea |
[surfaceArea accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Particle surface area in area base units (default is meters squared). Surface area
is used for calculations such as wind effects per particle.
Hint: surfaceArea value represents average frontal area presented to the wind.
Hint: assumes spherical model for each particle (i.e., surface area is the same regardless
of direction). |
| variation |
[variation accessType inputOutput, type SFFloat CDATA "0.25"] [0,+β)
Multiplier for the randomness used to control the range of possible output values.
The bigger the value, the more random the output and the bigger the range of possible
initial values possible.
Hint: variation of zero does not allow any randomness. |
| containerField |
[containerField type NMTOKEN "emitter"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
Switch |
[inherits X3DGroupingNode, implements X3DVisibleObject]
Switch is a Grouping node that only renders one (or zero) child at a time.
Switch can contain most nodes.
(Contained nodes are now called 'children' rather than 'choice',
for consistent naming among all GroupingNodeType nodes.)
All child choices continue to receive and send events regardless of whichChoice is
active.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: authors can temporarily hide test geometry under an unselected child of a Switch.
This is a good alternative to "commenting out" nodes.
Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more
than one of these nodes can be bound and active at a given time.
Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch,
instead use ViewpointGroup as parent to constrain location proximity where the viewpoint
is available to user.
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: contained nodes must have type X3DChildNode, such as Group or Transform or Shape.
Warning: Switch is not allowed as parent of Appearance, Material, Color, Coordinate, Normal
or Texture nodes. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| whichChoice |
[whichChoice accessType inputOutput, type SFInt32 CDATA "-1"] [-1,+β)
Index of active child choice, counting from 0.
Warning: default value whichChoice= -1 means no selection (and no rendering), whichChoice=0
means initial child, whichChoice=1 means second child, etc. |
| 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 (children|skin) 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 |
|
TexCoordChaser2D |
(X3D version 3.3 or later) [inherits X3DChaserNode]
TexCoordChaser2D generates a series of single floating-point values that progressively
change from initial value to destination value.
Hint: ROUTE value_changed output events to a <TextureTransform> node's translation field,
for example. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 MFVec2f CDATA #IMPLIED]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type MFVec2f CDATA #IMPLIED]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type MFVec2f 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 MFVec2f 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 MFVec2f 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 |
|
TexCoordDamper2D |
(X3D version 3.2 or later) [inherits X3DDamperNode]
TexCoordDamper2D generates a series of 2D floating-point arrays that progressively
change from initial value to destination value.
Hint: ROUTE value_changed output events to a <TextureTransform> node's translation field,
for example. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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 MFVec2f CDATA #IMPLIED]
Initial starting value for this node. |
| initialDestination |
[initialDestination accessType initializeOnly, type MFVec2f CDATA #IMPLIED]
Initial destination value for this node. |
| set_value |
[set_value accessType inputOnly, type MFVec2f 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 MFVec2f 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 MFVec2f 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 |
Text |
[inherits X3DGeometryNode]
Text is a 2D (flat) geometry node that can contain multiple lines of string values.
Layout and styling is controlled by a contained FontStyle node.
Hint: String (computer science) https://en.wikipedia.org/wiki/String_(computer_science)
Hint: full internationalization (i18n) and localization (l10n) features are available
for any written language.
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content.
Warning: Text node requires X3D profile='Immersive' or <component name='Text' level='1'/>
|
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| fontStyle |
[fontStyle accessType inputOutput, type SFNode singleton, NULL node] [X3DFontStyleNode]
The fontStyle field can contain a FontStyle or ScreenFontStyle node defining size,
family, and style for presented text.
Hint: Wikipedia https://en.wikipedia.org/wiki/Font |
| 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. |
| string |
[string accessType inputOutput, type MFString CDATA #IMPLIED]
Single or multiple string values to present as Text. Each value in the string array
(including empty strings) gets displayed on a separate line.
Hint: MFString arrays can have multiple values, so separate each individual string by
quote marks.
Hint: Strings can contain quote marks by first escaping them with a backslash example:
"say \"hello\" please"
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).
Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
Example: https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter02-GeometryPrimitives/TextIndex.html
Example: https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter02-GeometryPrimitives/TextSpecialCharactersIndex.html |
| length |
[length accessType inputOutput, type MFFloat CDATA #IMPLIED]
Array of length values for each text string in the local coordinate system. Each
string is stretched or compressed to fit. |
| maxExtent |
[maxExtent accessType inputOutput, type SFFloat CDATA "0.0"]
Limits/compresses all text strings if max string length is longer than maxExtent,
as measured in local coordinate system. |
| 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.
|
| lineBounds |
[lineBounds accessType outputOnly, type MFVec2f CDATA #IMPLIED]
Array of 2D bounding box values for each line of text in the local coordinate system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| origin |
[origin accessType outputOnly, type SFVec3f CDATA #IMPLIED]
origin of the text local coordinate system, in units of the coordinate system in
which the Text node is embedded. The value of the origin field represents the upper
left corner of the textBounds.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| textBounds |
[textBounds accessType outputOnly, type SFVec2f CDATA #IMPLIED]
2D bounding box value for all lines of text in the local coordinate system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| 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 |
|
TextureBackground |
[inherits X3DBackgroundNode]
TextureBackground simulates ground and sky, using vertical arrays of wraparound
color values,
TextureBackground can also provide backdrop texture images 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.
Warning: each of the child ImageTexture or PixelTexture nodes must have unique containerField
values for backTexture, bottomTexture, frontTexture, leftTexture, rightTexture, or
topTexture.
Hint: authors can have LoadSensor nodes receive notifications and send reporting events
when background texture node(s) are loaded. |
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 |
| backTexture |
[backTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode | MultiTexture]
Parent TextureBackground element can contain up to six image nodes (ImageTexture
PixelTexture MovieTexture MultiTexture).
Warning: each child image node must have a different containerField value. |
| bottomTexture |
[bottomTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode | MultiTexture]
Parent TextureBackground element can contain up to six image nodes (ImageTexture
PixelTexture MovieTexture MultiTexture).
Warning: each child image node must have a different containerField value. |
| frontTexture |
[frontTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode | MultiTexture]
Parent TextureBackground element can contain up to six image nodes (ImageTexture
PixelTexture MovieTexture MultiTexture).
Warning: each child image node must have a different containerField value. |
| leftTexture |
[leftTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode | MultiTexture]
Parent TextureBackground element can contain up to six image nodes (ImageTexture
PixelTexture MovieTexture MultiTexture).
Warning: each child image node must have a different containerField value. |
| rightTexture |
[rightTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode | MultiTexture]
Parent TextureBackground element can contain up to six image nodes (ImageTexture
PixelTexture MovieTexture MultiTexture).
Warning: each child image node must have a different containerField value. |
| topTexture |
[topTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture2DNode | MultiTexture]
Parent TextureBackground element can contain up to six image nodes (ImageTexture
PixelTexture MovieTexture MultiTexture).
Warning: each child image node must have a different containerField value. |
| 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. |
| 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 |
| transparency |
[transparency accessType inputOutput, type MFFloat CDATA "0"]
transparency applied to texture images, enabling an X3D scene to overlay an HTML
page or desktop. |
| 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 |
|
TextureCoordinate |
[inherits X3DSingleTextureCoordinateNode]
TextureCoordinate specifies 2D (s,t) texture-coordinate points, used by vertex-based
geometry nodes (such as IndexedFaceSet or ElevationGrid) to map textures to vertices
(and patches to NURBS surfaces).
Hint: add Shape and then polgyonal/planar geometry before adding TextureCoordinate.
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
Hint: X3D Texturing component Figure 18.1, Texture map coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#f-TextureMapCoordSystem |
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. |
| mapping |
[mapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| point |
[point accessType inputOutput, type MFVec2f CDATA #IMPLIED]
pairs of 2D (s,t) texture coordinates, either in range [0,1] or higher if repeating.
|
| containerField |
[containerField type NMTOKEN (texCoord|texCoordRamp) "texCoord"]
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 |
TextureCoordinate3D |
(X3D version 3.1 or later) [inherits X3DTextureCoordinateNode]
TextureCoordinate3D specifies a set of 3D texture coordinates used by vertex-based
geometry nodes (such as IndexedFaceSet or ElevationGrid) to map 3D textures to vertices.
Hint: add Shape and then polgyonal/planar geometry before adding texture coordinates.
Hint: X3D Architecture 33.2.2 3D texturing concepts https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texture3D.html#3DTextureconcepts
Warning: requires X3D profile='Full' or else include <component name='Texturing3D' level='1'/>
|
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. |
| mapping |
[mapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| point |
[point accessType inputOutput, type MFVec3f CDATA #IMPLIED]
triplets of 3D (s,t,r) texture coordinates, either in range [0,1] or higher if repeating.
|
| containerField |
[containerField type NMTOKEN "texCoord"]
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 |
TextureCoordinate4D |
(X3D version 3.1 or later) [inherits X3DTextureCoordinateNode]
TextureCoordinate4D specifies a set of 4D (homogeneous 3D) texture coordinates used
by vertex-based geometry nodes (such as IndexedFaceSet or ElevationGrid) to map 3D
textures to vertices.
Hint: add Shape and then polgyonal/planar geometry before adding texture coordinates.
Warning: requires X3D profile='Full' or else include <component name='Texturing3D' level='1'/>
|
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. |
| mapping |
[mapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| point |
[point accessType inputOutput, type MFVec4f CDATA #IMPLIED]
4-tuple values of 4D texture coordinates, either in range [0,1] or higher if repeating.
|
| containerField |
[containerField type NMTOKEN "texCoord"]
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 |
TextureCoordinateGenerator |
[inherits X3DSingleTextureCoordinateNode]
TextureCoordinateGenerator computes 2D (s,t) texture-coordinate points, used by
vertex-based geometry nodes (such as IndexedFaceSet or ElevationGrid) to map textures
to vertices (and patches to NURBS surfaces).
Hint: add Shape and then polgyonal/planar geometry before adding TextureCoordinateGenerator.
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
Hint: X3D Texturing component Figure 18.1, Texture map coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#f-TextureMapCoordSystem |
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. |
| mapping |
[mapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| mode |
[mode accessType inputOutput, type SFString CDATA ( SPHERE|CAMERASPACENORMAL|CAMERASPACEPOSITION|CAMERASPACEREFLECTIONVECTOR|SPHERE-LOCAL|COORD|COORD-EYE|NOISE|NOISE-EYE|SPHERE-REFLECT|SPHERE-REFLECT-LOCAL
) SPHERE]
parameter field defines the algorithm used to compute texture coordinates.
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 18.6 Texture coordinate generation modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-Texturecoordgeneration for further details. |
| parameter |
[parameter accessType inputOutput, type MFVec2f CDATA #IMPLIED]
parameter array contains scale and translation (x y z) values for Perlin NOISE mode,
parameter[0] contains index of refraction for SPHERE-REFLECT mode, parameter[0] contains
index of refraction and parameter[1 to 3] contains the eye point in local coordinates
for SPHERE-REFLECT-LOCAL mode. |
| containerField |
[containerField type NMTOKEN (texCoord|texCoordRamp) "texCoord"]
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 |
|
TextureProjector |
[inherits X3DTextureProjectorNode]
TextureProjector is similar to a light that projects a texture into the scene, illuminating
geometry that intersects the perspective projection volume.
Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Images/ptmperspective.png
Warning: add textureTransform field? |
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 |
| 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 |
| 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. |
| ambientIntensity |
[ambientIntensity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
Brightness of ambient (nondirectional background) emission from the light. Interchange
profile
Hint: this field may be ignored, applying the default value regardless. |
| color |
[color accessType inputOutput, type SFColor CDATA "1 1 1"] [0,1]
color of light, applied to colors of objects.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| 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). |
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 1 0"]
Direction for projection. |
| farDistance |
[farDistance accessType inputOutput, type SFFloat CDATA "-1"] or (0,+β)
maximum distance necessary for texture display. |
| fieldOfView |
[fieldOfView accessType inputOutput, type SFFloat CDATA "0.7854" (0,Ο)]
Preferred minimum viewing angle for this projection in radians, providing minimum
height or minimum width (whichever is smaller). Small field of view roughly corresponds
to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.
Warning: this field differs for TextureProjectorParallel and TextureProjector. |
| global |
[global accessType inputOutput, type SFBool (true|false) "false"]
Global texture projection illuminates all objects within their volume of influence.
Scoped texture projection (global false) only illuminates objects within the same
transformation hierarchy. |
| intensity |
[intensity accessType inputOutput, type SFFloat CDATA "1"] [0,1]
Brightness of direct emission from the light. |
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables this texture projection source. |
| location |
[location accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position of center of texture projection relative to local coordinate system. |
| nearDistance |
[nearDistance accessType inputOutput, type SFFloat CDATA "-1"] or (0,+β)
minimum distance necessary for texture display. |
| shadowIntensity |
[shadowIntensity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
shadowIntensity field defines how much light is obscured by shapes that cast shadows,
ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured,
full-intensity shadows). |
| shadows |
[shadows accessType inputOutput, type SFBool (true|false) "false"]
shadows field indicates whether or not this light casts a shadow behind illuminated
X3DShapeNode geometry. |
| upVector |
[upVector accessType inputOutput, type SFVec3f CDATA "0 1 0"]
upVector describes the roll of the camera by saying which direction is up for the
camera's orientation. |
| aspectRatio |
[aspectRatio accessType outputOnly, type SFFloat CDATA]
aspectRatio is the ratio of width and height that is projected. |
| containerField |
[containerField type NMTOKEN "texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
TextureProjectorParallel |
[inherits X3DTextureProjectorNode]
TextureProjectorParallel is similar to a light that projects a texture into the
scene, illuminating geometry that intersects the parallel projection volume.
Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Images/ptmparallel.png
Warning: add textureTransform field? |
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 |
| 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 |
| 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. |
| ambientIntensity |
[ambientIntensity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
Brightness of ambient (nondirectional background) emission from the light. Interchange
profile
Hint: this field may be ignored, applying the default value regardless. |
| color |
[color accessType inputOutput, type SFColor CDATA "1 1 1"] [0,1]
color of light, applied to colors of objects.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| 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). |
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 1 0"]
Direction for projection. |
| farDistance |
[farDistance accessType inputOutput, type SFFloat CDATA "-1"] or (0,+β)
maximum distance necessary for texture display. |
| fieldOfView |
[fieldOfView accessType inputOutput, type SFVec4f CDATA "-1 -1, 1 1"]
Minimum and maximum extents of projection texture in units of local coordinate system.
Small field of view roughly corresponds to a telephoto lens, large field of view roughly
corresponds to a wide-angle lens.
Warning: minimum corner values must remain less than maximum corner values.
Hint: rectangular display width/height = (maxX-minX) / (maxY-minY).
Warning: this field differs for TextureProjectorParallel and TextureProjector. |
| global |
[global accessType inputOutput, type SFBool (true|false) "false"]
Global texture projection illuminates all objects within their volume of influence.
Scoped texture projection (global false) only illuminates objects within the same
transformation hierarchy. |
| intensity |
[intensity accessType inputOutput, type SFFloat CDATA "1"] [0,1]
Brightness of direct emission from the light. |
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables this texture projection source. |
| location |
[location accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Position of center of texture projection relative to local coordinate system. |
| nearDistance |
[nearDistance accessType inputOutput, type SFFloat CDATA "-1"] or (0,+β)
minimum distance necessary for texture display. |
| shadowIntensity |
[shadowIntensity accessType inputOutput, type SFFloat CDATA "0"] [0,1]
shadowIntensity field defines how much light is obscured by shapes that cast shadows,
ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured,
full-intensity shadows). |
| shadows |
[shadows accessType inputOutput, type SFBool (true|false) "false"]
shadows field indicates whether or not this light casts a shadow behind illuminated
X3DShapeNode geometry. |
| upVector |
[upVector accessType inputOutput, type SFVec3f CDATA "0 1 0"]
upVector describes the roll of the camera by saying which direction is up for the
camera's orientation. |
| aspectRatio |
[aspectRatio accessType outputOnly, type SFFloat CDATA]
aspectRatio is the ratio of width and height that is projected. |
| containerField |
[containerField type NMTOKEN "texture"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
TextureProperties |
[inherits X3DNode]
TextureProperties allows precise fine-grained control over application of image
textures to geometry.
Warning: requires X3D profile='Full' or else include <component name='Shape' level='2'/>
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping |
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. |
| anisotropicDegree |
[anisotropicDegree accessType inputOutput, type SFFloat CDATA "1"] [1,+β)
anisotropicDegree defines minimum degree of anisotropy to account for in texture
filtering (1=no effect for symmetric filtering, otherwise provide higher value). At
least 2-to-1 anisotropy is often supported in low-level graphics rendering software
and hardware, relative to horizontal and vertical directions.
Hint: Anisotropy indicates directional dependence of properties. https://en.wikipedia.org/wiki/Anisotropy
Hint: OpenGL EXT_texture_filter_anisotropic https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_filter_anisotropic.txt |
| borderColor |
[borderColor accessType inputOutput, type SFColorRGBA CDATA "0 0 0 0"] [0,1]
borderColor defines border pixel color.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| borderWidth |
[borderWidth accessType inputOutput, type SFInt32 CDATA "0"] [0,+β)
borderWidth number of pixels for texture border. |
| boundaryModeS |
[boundaryModeS accessType inputOutput, type SFString CDATA ( CLAMP|CLAMP_TO_EDGE|CLAMP_TO_BOUNDARY|MIRRORED_REPEAT|REPEAT ) REPEAT]
boundaryModeS describes handling of texture-coordinate boundaries.
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 18.7 Texture boundary modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-TextureBoundaryModes for details. |
| boundaryModeT |
[boundaryModeT accessType inputOutput, type SFString CDATA ( CLAMP|CLAMP_TO_EDGE|CLAMP_TO_BOUNDARY|MIRRORED_REPEAT|REPEAT ) REPEAT]
boundaryModeT describes handling of texture-coordinate boundaries.
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 18.7 Texture boundary modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-TextureBoundaryModes for details. |
| boundaryModeR |
[boundaryModeR accessType inputOutput, type SFString CDATA ( CLAMP|CLAMP_TO_EDGE|CLAMP_TO_BOUNDARY|MIRRORED_REPEAT|REPEAT ) REPEAT]
boundaryModeR describes handling of texture-coordinate boundaries.
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 18.7 Texture boundary modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-TextureBoundaryModes for details. |
| generateMipMaps |
[generateMipMaps accessType initializeOnly, type SFBool (true|false) "false"]
Determines whether MIPMAPs are generated for texture images.
Warning: must declare generateMipMaps='true' for minificationFilter modes with MIPMAP in
their value.
Hint: mipmap preprocessing is a low-level rendering technique that can increase rendering
speed and reduce aliasing artifacts.
Hint: Mipmap pyramids are pre-calculated, optimized sequences of images, each of which
is a progressively lower resolution representation of the same image. The height and
width of each image level in the mipmap is a power of two smaller than the previous
level.
Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
Hint: Mipmap https://en.wikipedia.org/wiki/Mipmap |
| magnificationFilter |
[magnificationFilter accessType inputOutput, type SFString CDATA ( AVG_PIXEL|DEFAULT|FASTEST|NEAREST_PIXEL|NICEST ) FASTEST]
magnificationFilter indicates texture filter when image is smaller than screen space
representation.
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 18.8 Texture magnification modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-TextureMagnificationModes for details. |
| minificationFilter |
[minificationFilter accessType inputOutput, type SFString CDATA ( AVG_PIXEL|AVG_PIXEL_AVG_MIPMAP|AVG_PIXEL_NEAREST_MIPMAP|DEFAULT|FASTEST|NEAREST_PIXEL|NEAREST_PIXEL_AVG_MIPMAP|NEAREST_PIXEL_NEAREST_MIPMAP|NICEST
) FASTEST]
minificationFilter indicates texture filter when image is larger than screen space
representation.
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 18.9 Texture minification modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-TextureMinificationModes for details. |
| textureCompression |
[textureCompression accessType inputOutput, type SFString CDATA ( DEFAULT|FASTEST|HIGH|LOW|MEDIUM|NICEST ) FASTEST]
textureCompression indicates compression algorithm selection mode.
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 18.10 Texture compression modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-TextureCompressionModes for details.
Hint: Texture compression https://en.wikipedia.org/wiki/Texture_compression |
| texturePriority |
[texturePriority accessType inputOutput, type SFFloat CDATA "0"] [0,1]
texturePriority defines relative priority for this texture when allocating texture
memory, an important rendering resource in graphics-card hardware. Default value 0
is lowest, 1 is highest. |
| containerField |
[containerField type NMTOKEN "lineProperties"]
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 |
|
TextureTransform |
[inherits X3DTextureTransformNode]
TextureTransform shifts 2D texture coordinates for positioning, orienting and scaling
image textures on geometry.
Warning: resulting visible effects appear reversed because image changes occur before mapping
to geometry.
Hint: order of operations is translation, rotation about center, non-uniform scale about
center.
Hint: insert Shape and Appearance nodes before adding TextureTransform.
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping |
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. |
| mapping |
[mapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| translation |
[translation accessType inputOutput, type SFVec2f CDATA "0 0"]
Lateral/vertical shift in 2D (s,t) texture coordinates (opposite effect appears
on geometry). |
| center |
[center accessType inputOutput, type SFVec2f CDATA "0 0"]
center point in 2D (s,t) texture coordinates for rotation and scaling. |
| rotation |
[rotation accessType inputOutput, type SFFloat CDATA "0"]
single rotation angle of texture about center (opposite effect appears on geometry).
Warning: use a single radian angle value, not a 4-tuple Rotation. |
| scale |
[scale accessType inputOutput, type SFVec2f CDATA "1 1"]
Non-uniform planar scaling of texture about center (opposite effect appears on geometry).
|
| containerField |
[containerField type NMTOKEN "textureTransform"]
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 |
|
TextureTransform3D |
(X3D version 3.1 or later) [inherits X3DTextureTransformNode]
TextureTransform3D applies a 3D transformation to texture coordinates.
Warning: resulting visible effects appear reversed because image changes occur before mapping
to geometry.
Hint: order of operations is translation, rotation about center, non-uniform scale about
center.
Hint: insert Shape and Appearance nodes before adding TextureTransform3D.
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping |
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. |
| center |
[center accessType inputOutput, type SFVec3f CDATA "0 0 0"]
center point in 2D (s,t) texture coordinates for rotation and scaling. |
| mapping |
[mapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| rotation |
[rotation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
rotation angle of texture about center (opposite effect appears on geometry). |
| scale |
[scale accessType inputOutput, type SFVec3f CDATA "1 1 1"]
Non-uniform planar scaling of texture about center (opposite effect appears on geometry).
|
| translation |
[translation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Lateral/vertical shift in 2D (s,t) texture coordinates (opposite effect appears
on geometry). |
| containerField |
[containerField type NMTOKEN "textureTransform"]
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 |
TextureTransformMatrix3D |
(X3D version 3.1 or later) [inherits X3DTextureTransformNode]
TextureTransformMatrix3D applies a 3D transformation to texture coordinates.
Warning: resulting visible effects appear reversed because image changes occur before mapping
to geometry.
Hint: order of operations is translation, rotation about center, non-uniform scale about
center.
Hint: insert Shape and Appearance nodes before adding TextureTransformMatrix3D.
Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
Warning: requires X3D profile='Full' or else include <component name='Texturing3D' level='1'/>
|
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. |
| mapping |
[mapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| matrix |
[matrix accessType inputOutput, type SFMatrix4f CDATA "1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1"]
matrix is a generalized, unfiltered 4x4 transformation matrix to modify texture
(opposite effect appears on geometry). |
| containerField |
[containerField type NMTOKEN "textureTransform"]
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 |
TimeSensor |
[inherits X3DTimeDependentNode, implements X3DSensorNode]
TimeSensor continuously generates events as time passes.
Typical use: ROUTE thisTimeSensorDEF.fraction_changed TO someInterpolatorDEF.set_fraction.
Interchange profile
Hint: TimeSensor may be ignored if cycleInterval < 0.01 second.
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: X3D Architecture 8 Time component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/time.html
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. |
| cycleInterval |
[cycleInterval accessType inputOutput, type SFTime CDATA "1.0"] [0,+β)
cycleInterval is loop duration in seconds. Interchange profile
Hint: TimeSensor may be ignored if cycleInterval < 0.01 second.
Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
Hint: cycleInterval is a nonnegative SFTime duration interval, not an absolute clock time.
|
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| loop |
[loop accessType inputOutput, type SFBool (true|false) "false"]
Repeat indefinitely when loop=true, repeat only once when loop=false. |
| startTime |
[startTime accessType inputOutput, type SFTime CDATA "0"]
When time now >= startTime, isActive becomes true and TimeSensor 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. |
| stopTime |
[stopTime accessType inputOutput, type SFTime CDATA "0"]
When stopTime becomes <= time now, isActive becomes false and TimeSensor becomes
inactive. 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. |
| cycleTime |
[cycleTime accessType outputOnly, type SFTime CDATA #FIXED ""]
cycleTime sends a time outputOnly at startTime, and also at the beginning of each
new cycle (useful for synchronization with other time-based objects).
Hint: the first cycleTime event for a TimeSensor node can be used as an alarm (single
pulse at a specified time).
Hint: cycleTime is a nonnegative SFTime duration interval, not an absolute clock 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. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when TimeSensor starts/stops running.
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 TimeSensor is paused/resumed.
Warning: not supported in VRML97.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| pauseTime |
[pauseTime accessType inputOutput, type SFTime CDATA "0"]
When time now >= pauseTime, isPaused becomes true and TimeSensor 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.
Warning: not supported in VRML97. |
| resumeTime |
[resumeTime accessType inputOutput, type SFTime CDATA "0"]
When resumeTime becomes <= time now, isPaused becomes false and TimeSensor becomes
inactive. 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: not supported in VRML97. |
| elapsedTime |
[elapsedTime accessType outputOnly, type SFTime CDATA #FIXED ""] [0,+β)
Current elapsed time since TimeSensor activated/running, cumulative in seconds,
and not counting any paused time.
Warning: not supported in VRML97.
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.
|
| fraction_changed |
[fraction_changed accessType outputOnly, type SFFloat CDATA #FIXED ""]
fraction_changed continuously sends value in range [0,1] showing time progress in
the current cycle.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| time |
[time accessType outputOnly, type SFTime CDATA #FIXED ""] [0,+β)
Time continuously sends the absolute time (value 0.0 matches 1 January 1970) in
seconds for a given simulation tick.
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 |
|
TimeTrigger |
[inherits X3DTriggerNode]
TimeTrigger converts boolean true events to time 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 ""]
If input event set_boolean is true, send output triggerTime event.
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. |
| triggerTime |
[triggerTime accessType outputOnly, type SFTime CDATA #FIXED ""]
triggerTime is output time event, sent when input event set_boolean is true.
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 |
ToneMappedVolumeStyle |
(X3D version 3.3 or later) [inherits X3DComposableVolumeRenderStyleNode]
ToneMappedVolumeStyle specifies that volumetric data is rendered with Gooch shading
model of two-toned warm/cool coloring.
Hint: ToneMappedVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals'
Hint: Gooch shading https://en.wikipedia.org/wiki/Gooch_shading
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. |
| coolColor |
[coolColor accessType inputOutput, type SFColorRGBA CDATA "0 0 1 0"] [0,1]
coolColor is used for surfaces facing away from the light direction.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| warmColor |
[warmColor accessType inputOutput, type SFColorRGBA CDATA "1 1 0 0"] [0,1]
warmColor is used for surfaces facing towards the light.
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 |
|
TouchSensor |
[inherits X3DTouchSensorNode]
TouchSensor tracks location and state of the pointing device,
detecting when a user points at or selects (activates) geometry.
Hint: this sensor detects user interactions affecting peer nodes and their child geometry.
Hint: X3D Architecture 20.2.1 Overview of pointing device sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html#OverviewOfPointingDeviceSensors
Hint: X3D Architecture 20.2.3 Activating and manipulating pointing device sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html#Activatingandmanipulating
Hint: example scenes and authoring assets at https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter08UserInteractivity |
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. |
| description |
[description accessType inputOutput, type SFString CDATA #IMPLIED]
Author-provided prose that describes intended purpose of this node.
Hint: include space characters since a description is not a DEF identifier. Write short
phrases that make descriptions clear and readable.
Hint: many XML tools substitute XML character references for special characters automatically
if needed within an attribute value (such as & for & ampersand character, or "
for " quotation-mark character). |
| enabled |
[enabled accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables node operation. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
Select geometry by activating the pointing device (for example, clicking the mouse)
to generate isActive events. Output event isActive=true is sent when pointing device
selection is activated, output event isActive=false is sent when pointing device is
deselected.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isOver |
[isOver accessType outputOnly, type SFBool #FIXED ""]
Hover over geometry by aiming the mouse (or pointing device) to generate isOver
events. Sensor sends output event isOver=true event when pointing device moves over
sensor's geometry, and later sends output event isOver=false event when pointing device
moves off.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| hitPoint_changed |
[hitPoint_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
When pointing device selects geometry, send event containing 3D point on surface
of underlying geometry, as measured in reference frame for TouchSensor's local coordinate
system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| hitNormal_changed |
[hitNormal_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
When pointing device selects geometry, send event containing surface normal vector
at the hitPoint.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| hitTexCoord_changed |
[hitTexCoord_changed accessType outputOnly, type SFVec2f CDATA #FIXED ""]
When pointing device selects geometry, send event containing texture coordinates
of surface at the hitPoint.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| touchTime |
[touchTime accessType outputOnly, type SFTime CDATA "0"]
Time event generated when sensor is touched by pointing device, and then deselected
by the user.
Hint: touchTime event is generated when following three conditions are all met: (a) pointing
device was pointing towards geometry when initially activated (isActive=true), (b)
pointing device is currently pointing towards the geometry (isOver=true), and (c)
pointing device selection is deactivated/deselected by user (isActive=false event
is also generated).
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 |
|
Transform |
[inherits X3DGroupingNode, implements X3DVisibleObject]
Transform is a Grouping node that can contain most nodes. Transform translates,
orients and scales child geometry within the local world coordinate system.
Hint: each transformation creates a new coordinate system relative to the parent coordinate
system.
Hint: +Y axis is the up direction. (Similarly some scenes may consider +X is North and
+Z is East.)
Hint: best authoring approach is to keep +Y axis pointing towards local up direction,
supporting scene composability and effective navigation response (which is based on
gravity direction).
Hint: insert a Shape node before adding geometry or Appearance.
Hint: translation/rotation/scaling field attributes can be defined in any order in the
scene. The applied order of translation/rotation/scaling transformation-matrix operations
remains consistent.
Hint: authors can modify order of translation/rotation/scaling operations by splitting
them into separate nested parent/child Transform nodes.
Warning: Transform contained by CADFace can only hold a single LOD or Shape node.
Hint: X3D Scene Authoring Hints, Coordinate Systems https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#CoordinateSystems
Hint: X3D Scene Authoring Hints, Scale Factors and Unit Conversions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scale
Hint: apply containerField='shape' if parent node is CADFace. |
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. |
| 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.
Hint: negative scale values allowed beginning with X3D version 3.1 |
| 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|proxy|rootNode|shape|skin) "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 |
|
TransformSensor |
(X3D version 3.2 or later) [inherits X3DEnvironmentalSensorNode]
TransformSensor generates output events when its targetObject enters, exits, and
moves within a region in space (defined by a box).
Hint: Each TransformSensor node behaves independently of all other TransformSensor nodes,
so that every enabled TransformSensor node affected by targetObject motion sends output
events.
Hint: multiply instanced (DEF/USE) TransformSensor nodes in different locations use the
union of all boxes to check for enter and exit, detecting enter and exit for all instances
of the box, and sending enter/exit events appropriately. For non-overlapping bounding
boxes, position_changed and orientation_changed events are calculated relative to
the coordinate system associated with the bounding box in which the proximity was
detected.
Warning: results are undefined if boxes overlap for multiply instanced TransformSensor nodes.
Warning: a TransformSensor node with a zero-volume box (i.e. any size dimension equal to
0.0) cannot generate events, equivalent to enabled=false.
Warning: unlike TouchSensor nodes, there is no notion of a TransformSensor node lower in
the scene graph grabbing events. |
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 |
| targetObject |
[targetObject accessType inputOutput, type SFNode singleton, NULL node] [X3DGroupingNode | X3DShapeNode]
targetObject is the movable geometry represented by any valid X3DGroupingNode or
X3DShapeNode which may enter or exit the box. |
| 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. |
| center |
[center accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Translation offset from origin of local coordinate system. |
| size |
[size accessType inputOutput, type SFVec3f CDATA "0 0 0"] [0,+β)
size of transformation-traccking box around center location, oriented within local
transformation frame. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when triggering the sensor. isActive=true when
targetObject enters the box region, isActive=false when targetObject exits the box
region.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| enterTime |
[enterTime accessType outputOnly, type SFTime CDATA #FIXED ""]
Time event generated when targetObject enters the box region for sensor.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| exitTime |
[exitTime accessType outputOnly, type SFTime CDATA #FIXED ""]
Time event generated when targetObject exits the box region for sensor.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| position_changed |
[position_changed accessType outputOnly, type SFVec3f CDATA #FIXED ""]
Sends translation event relative to center whenever the target object is contained
within the box region and results change.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| orientation_changed |
[orientation_changed accessType outputOnly, type SFRotation CDATA #FIXED ""]
Sends rotation event relative to center whenever the target object is contained
within the box region and results change.
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 |
TransmitterPdu |
[inherits X3DNetworkSensorNode, implements X3DBoundedObject, X3DVisibleObject]
TransmitterPdu is a networked Protocol Data Unit (PDU) information node that provides
detailed information about a radio transmitter modeled in a simulation.
Hint: TransmitterPdu packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
Hint: Savage Developers Guide on DIS https://savage.nps.edu/Savage/developers.html#DIS
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
Warning: requires X3D profile='Full' or else include <component name='DIS' level='1'/> |
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 the sensor node. |
| whichGeometry |
[whichGeometry accessType inputOutput, type SFInt32 CDATA "1"]
Select geometry to render: -1 for no geometry, 0 for text trace, 1 for default geometry,
(optional) higher values to render different states. |
| 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.
|
| 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). |
| 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. |
| entityID |
[entityID accessType inputOutput, type SFInt32 CDATA "0"]
EntityID unique ID for entity within that application. |
| applicationID |
[applicationID accessType inputOutput, type SFInt32 CDATA "0"]
Each simulation application that can respond to simulation management PDUs needs
to have a unique applicationID. |
| siteID |
[siteID accessType inputOutput, type SFInt32 CDATA "0"]
Simulation/exercise siteID of the participating LAN or organization. |
| readInterval |
[readInterval accessType inputOutput, type SFTime CDATA "0.1"] [0,+β)
Seconds between read updates, 0 means no reading.
Hint: readInterval is a nonnegative SFTime duration interval, not an absolute clock time.
|
| writeInterval |
[writeInterval accessType inputOutput, type SFTime CDATA "1.0"] [0,+β)
Seconds between write updates, 0 means no writing (sending).
Hint: writeInterval is a nonnegative SFTime duration interval, not an absolute clock time.
|
| networkMode |
[networkMode accessType inputOutput, type SFString CDATA ( standAlone|networkReader|networkWriter ) standAlone]
Whether this entity is ignoring the network, sending DIS packets to the network,
or receiving DIS packets from the network. (1) standAlone: ignore network but still
respond to events in local scene. (2) networkReader: listen to network and read PDU
packets at readInterval, act as remotely linked copy of entity. (3) networkWriter:
send PDU packets to network at writeInterval, act as master entity. Default value
"standAlone" ensures that DIS network activation within a scene as networkReader or
networkWriter is intentional.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values.
Warning: network activity may have associated security issues. |
| isStandAlone |
[isStandAlone accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='local' (ignore network but still respond to local events).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isNetworkReader |
[isNetworkReader accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='remote' (listen to network as copy of remote entity).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isNetworkWriter |
[isNetworkWriter accessType outputOnly, type SFBool #FIXED ""]
Whether networkMode='master' (output to network as master entity at writeInterval).
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| address |
[address accessType inputOutput, type SFString CDATA localhost]
Multicast network address, or else 'localhost'.
Example: 224.2.181.145. |
| port |
[port accessType inputOutput, type SFInt32 CDATA "0"]
Multicast network port, for example: 3000. |
| multicastRelayHost |
[multicastRelayHost accessType inputOutput, type SFString CDATA #IMPLIED]
Fallback server address if multicast not available locally. For example: track.nps.edu.
|
| multicastRelayPort |
[multicastRelayPort accessType inputOutput, type SFInt32 CDATA "0"]
Fallback server port if multicast not available locally. For example: 8010. |
| rtpHeaderExpected |
[rtpHeaderExpected accessType inputOutput, type SFBool (true|false) "false"]
Whether RTP headers are prepended to DIS PDUs. |
| isRtpHeaderHeard |
[isRtpHeaderHeard accessType outputOnly, type SFBool #FIXED ""]
Whether incoming DIS packets have an RTP header prepended.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
confirm whether there has been a recent network update.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| timestamp |
[timestamp accessType outputOnly, type SFTime CDATA #FIXED ""]
DIS timestamp in X3D units (value 0.0 matches 1 January 1970) in seconds.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| radioID |
[radioID accessType inputOutput, type SFInt32 CDATA "0"]
Identifies a particular radio within a given entity. |
| antennaLocation |
[antennaLocation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
World coordinates for antenna location. |
| relativeAntennaLocation |
[relativeAntennaLocation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Relative coordinates for antenna location. |
| antennaPatternLength |
[antennaPatternLength accessType inputOutput, type SFInt32 CDATA "0"]
|
| antennaPatternType |
[antennaPatternType accessType inputOutput, type SFInt32 CDATA "0"]
Antenna shape pattern: 0 for omnidirectional, 1 for beam, 2 for spherical harmonic
(deprecated), or optional higher value |
| cryptoKeyID |
[cryptoKeyID accessType inputOutput, type SFInt32 CDATA "0"]
Nonzero value corresponding to the simulated cryptographic key. Enumerations value
0 indicates plain (unencrypted) communications. |
| cryptoSystem |
[cryptoSystem accessType inputOutput, type SFInt32 CDATA "0"]
Indicates type of crypto system being used, even if the encryption equipment is
not keyed. Value 0 for No Encryption Device, higher enumerations values correspond
to other specific equipment. |
| frequency |
[frequency accessType inputOutput, type SFInt32 CDATA "0"] [0,+β)
Transmission frequency in Hz. If the radio is in frequency hopping mode, this field
may be set to the center of the frequency hopping band currently in use, or to some
other appropriate value. |
| inputSource |
[inputSource accessType inputOutput, type SFInt32 CDATA "0"]
Source of transmission input. Enumerations value 0 for Other, 1 for Pilot, 2 for
Copilot, 3 for First Officer, 4 for Driver, 5 for Loader, 6 for Gunner, 7 for Commander,
8 for Digital Data Device, 9 for Intercom, 10 for Audio Jammer, 11 for Data Jammer,
12 for GPS Jammer, 13 for GPS Meaconer (masking beacon). |
| lengthOfModulationParameters |
[lengthOfModulationParameters accessType inputOutput, type SFInt32 CDATA "0"]
|
| modulationTypeDetail |
[modulationTypeDetail accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumeration containing detailed information depending on the major modulation
type. |
| modulationTypeMajor |
[modulationTypeMajor accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumeration containing major classification of the modulation type. Enumerations
value 0 for No Statement, 1 for Amplitude, 2 for Amplitude and Angle, 3 for Angle,
4 for Combination, 5 for Pulse, 6 for Unmodulated, 7 for Carrier Phase Shift Modulation
(CPSM). |
| modulationTypeSpreadSpectrum |
[modulationTypeSpreadSpectrum accessType inputOutput, type SFInt32 CDATA "0"]
Indicates the spread spectrum technique or combination of spread spectrum techniques
in use. |
| modulationTypeSystem |
[modulationTypeSystem accessType inputOutput, type SFInt32 CDATA "0"]
Specifies radio system associated with this Transmitter PDU and used to interpret
other fields whose values depend on a specific radio system. |
| power |
[power accessType inputOutput, type SFFloat CDATA "0"]
Power that radio would be capable of outputting if on and transmitting, independent
of actual transmit state of the radio. |
| radioEntityTypeCategory |
[radioEntityTypeCategory accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumeration containing EntityType of transmitter radio. Enumerations value:
0 for Other, 1 for Generic Radio or Simple Intercom, 2 for HAVE QUICK, 3 for HAVE
QUICK II, 4 for HAVE QUICK IIA, 5 for SINCGARS, 6 for CCTT SINCGARS, 7 for EPLRS (Enhanced
Position Location Reporting System), 8 for JTIDS/MIDS, 9 for Link 11, 10 for Link
11B, 11 for L-Band SATCOM, 12 for Enhanced SINCGARS 7.3, 13 for Navigation Aid. |
| radioEntityTypeCountry |
[radioEntityTypeCountry accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for country to which the design of the entity or its
design specification is attributed. |
| radioEntityTypeDomain |
[radioEntityTypeDomain accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE,
SUBSURFACE, SPACE or OTHER. |
| radioEntityTypeKind |
[radioEntityTypeKind accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM,
ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER.
|
| radioEntityTypeNomenclature |
[radioEntityTypeNomenclature accessType inputOutput, type SFInt32 CDATA "0"]
Integer enumerations value indicating nomenclature (name) for a particular emitter.
See DIS enumerations reference for value/name pairs. |
| radioEntityTypeNomenclatureVersion |
[radioEntityTypeNomenclatureVersion accessType inputOutput, type SFInt32 CDATA "0"]
Named equipment version number. |
| transmitFrequencyBandwidth |
[transmitFrequencyBandwidth accessType inputOutput, type SFFloat CDATA "0.0"]
Bandwidth of the particular transmitter measured between the half-power (-3 dB)
points (this value represents total bandwidth, not the deviation from the center frequency).
|
| transmitState |
[transmitState accessType inputOutput, type SFInt32 CDATA "0"]
Specify radio transmission state where enumerations value 0 is for off, value 1
for powered but not transmitting, or value 1 is for powered and transmitting, |
| geoCoords |
(X3D version 3.3 or later) [geoCoords accessType inputOutput, type SFVec3d CDATA "0 0 0"]
Geographic location (specified in current geoSystem coordinates) for children geometry
(specified in relative coordinate system, in meters).
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'/>
|
| geoSystem |
(X3D version 3.3 or later) [geoSystem accessType initializeOnly, type MFString CDATA "GD" "WE"]
Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse
Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted
string parameters as appropriate for the type.
Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). |
| 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 |
|
TriangleFanSet |
[inherits X3DComposedGeometryNode]
TriangleFanSet is a geometry node containing a Coordinate|CoordinateDouble node,
and can also contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
Hint: color, normal and texCoord values are applied in the same order as coord values.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate
node that can specify coordinates for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| fanCount |
[fanCount accessType initializeOnly, type MFInt32 CDATA #IMPLIED] (3,+β)
fanCount array provides number of vertices in each fan. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color|ColorRGBA values are applied to each point vertex (true) or to each
polygon face (false).
Warning: the provided value of TriangleFanSet colorPerVertex field is ignored and always
treated as true.
Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding
Appearance and material/texture values.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or to
each polygon face (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. |
| 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.
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 |
|
TriangleSet |
[inherits X3DComposedGeometryNode]
TriangleSet is a geometry node containing a Coordinate|CoordinateDouble node, and
can also contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
Hint: color, normal and texCoord values are applied in the same order as coord values.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate
node that can specify coordinates for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color|ColorRGBA values are applied to each point vertex (true) or to each
polygon face (false).
Warning: the provided value of TriangleSet colorPerVertex field is ignored and always treated
as true.
Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding
Appearance and material/texture values.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or to
each polygon face (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. |
| 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.
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 |
TriangleSet2D |
[inherits X3DGeometryNode]
TriangleSet2D is a geometry node that defines a set of filled 2D triangles in X-Y
plane.
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. |
| vertices |
[vertices accessType initializeOnly, type MFVec2f CDATA #FIXED ""]
2D coordinates of TriangleSet2D vertices.
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 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 |
|
TriangleStripSet |
[inherits X3DComposedGeometryNode]
TriangleStripSet is a geometry node containing a Coordinate|CoordinateDouble node,
and can also contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
Hint: color, normal and texCoord values are applied in the same order as coord values.
Hint: insert a Shape node before adding geometry or Appearance.
Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance
node (with correct containerField value) for contained node content. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| attrib |
[attrib accessType inputOutput, type MFNode array, empty list] [X3DVertexAttributeNode]
Single contained FloatVertexAttribute node that can specify list of per-vertex attribute
information for programmable shaders.
Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html#Pervertexattributes |
| color |
[color accessType inputOutput, type SFNode singleton, NULL node] [X3DColorNode]
Single contained Color or ColorRGBA node that can specify color values applied to
corresponding vertices according to colorIndex and colorPerVertex fields. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Single contained Coordinate or CoordinateDouble node that can specify a list of
vertex values. |
| fogCoord |
[fogCoord accessType inputOutput, type SFNode singleton, NULL node] [FogCoordinate]
Single contained FogCoordinate node that can specify depth parameters for fog in
corresponding geometry. |
| normal |
[normal accessType inputOutput, type SFNode singleton, NULL node] [X3DNormalNode]
Single contained Normal node that can specify perpendicular vectors for corresponding
vertices to support rendering computations, applied according to the normalPerVertex
field.
Hint: useful for special effects. Normal vector computation by 3D graphics hardware is
quite fast so adding normals to a scene is typically unnecessary.
Warning: normal vectors increase file size, typically doubling geometry definitions. Normal
vectors are rapidly computed at run time by GPUs and thus are rarely needed in model
files if no special effects are expected. |
| texCoord |
[texCoord accessType inputOutput, type SFNode singleton, NULL node] [X3DTextureCoordinateNode]
Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate
node that can specify coordinates for texture mapping onto corresponding geometry.
|
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| stripCount |
[stripCount accessType initializeOnly, type MFInt32 CDATA #IMPLIED] (3,+β)
stripCount array provides number of vertices in each strip.
Warning: do not exceed number of points in contained Coordinate|CoordinateDouble node. |
| ccw |
[ccw accessType initializeOnly, type SFBool (true|false) "true"]
ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in
turn defines front/back orientation of polygon normals according to Right-Hand Rule
(RHR).
Hint: a good debugging technique for problematic polygons is to try changing the value
of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector
direction.
Warning: consistent and correct ordering of left-handed or right-handed point sequences is
important throughout the coord array of point values.
Hint: clockwise https://en.wikipedia.org/wiki/Clockwise |
| colorPerVertex |
[colorPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Color|ColorRGBA values are applied to each point vertex (true) or to each
polygon face (false).
Warning: the provided value of TriangleStripSet colorPerVertex field is ignored and always
treated as true.
Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding
Appearance and material/texture values.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color |
| normalPerVertex |
[normalPerVertex accessType initializeOnly, type SFBool (true|false) "true"]
Whether Normal node vector values are applied to each point vertex (true) or to
each polygon face (false).
Hint: if no child Normal node is provided, the X3D browser shall automatically generate
normals, using creaseAngle to determine smoothed shading across shared vertices. |
| 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.
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 |
|
TwoSidedMaterial |
(X3D version 3.2 or later) [inherits X3DMaterialNode]
TwoSidedMaterial specifies surface rendering properties for associated geometry
nodes, for outer (front) and inner (back) sides of polygons.
Material attributes are used by the X3D lighting equations during rendering.
Warning: requires X3D profile='Full' or else include <component name='Shape' level='4'/>
Hint: insert Shape and Appearance nodes before adding material.
Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related
shapes in a scene.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
Warning: corresponding geometry within the parent Shape must have solid='false' for two-sided
rendering, otherwise no reverse-side back geometry is displayed.
Hint: X3D Architecture 12.2.3 Two-sided materials https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shape.html#TwoSidedMaterials
Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/lighting.html#Lightingmodel
Warning: X3D4 Architecture has deprecated TwoSidedMaterial, preferring use of child backMaterial
node in parent 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. |
| separateBackColor |
[separateBackColor accessType inputOutput, type SFBool (true|false) "false"]
separateBackColor determines whether separate Material values are used for back
faces.
Warning: backface Material values are ignored unless you set separateBackColor='true' |
| backDiffuseColor |
[backDiffuseColor accessType inputOutput, type SFColor CDATA "0.8 0.8 0.8"] [0,1]
how much direct, angle-dependent light is reflected from all light sources.
Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet. |
| backEmissiveColor |
[backEmissiveColor accessType inputOutput, type SFColor CDATA "0 0 0"] [0,1]
how much glowing light is emitted from this object.
Hint: emissiveColors glow even when all lights are off.
Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
Warning: bright emissiveColor values can wash out other colors and some textures. |
| backSpecularColor |
[backSpecularColor accessType inputOutput, type SFColor CDATA "0 0 0"] [0,1]
specular highlights are brightness reflections (example: shiny spots on an apple).
Interchange profile
Hint: this field may be ignored, applying the default value regardless. |
| backShininess |
[backShininess accessType inputOutput, type SFFloat CDATA "0.2"] [0,1]
Lower shininess values provide soft specular glows, while higher values result in
sharper, smaller highlights. Interchange profile
Hint: this field may be ignored, applying the default value regardless. |
| backAmbientIntensity |
[backAmbientIntensity accessType inputOutput, type SFFloat CDATA "0.2"] [0,1]
how much ambient omnidirectional light is reflected from all light sources. Interchange
profile
Hint: this field may be ignored, applying the default value regardless. |
| backTransparency |
[backTransparency accessType inputOutput, type SFFloat CDATA "0"] [0,1]
how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque.
Interchange profile
Hint: transparency < .5 opaque, transparency > .5 transparent. |
| diffuseColor |
[diffuseColor accessType inputOutput, type SFColor CDATA "0.8 0.8 0.8"] [0,1]
how much direct, angle-dependent light is reflected from all light sources.
Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet. |
| emissiveColor |
[emissiveColor accessType inputOutput, type SFColor CDATA "0 0 0"] [0,1]
how much glowing light is emitted from this object.
Hint: emissiveColors glow even when all lights are off.
Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
Warning: bright emissiveColor values can wash out other colors and some textures. |
| specularColor |
[specularColor accessType inputOutput, type SFColor CDATA "0 0 0"] [0,1]
specular highlights are brightness reflections (example: shiny spots on an apple).
Interchange profile
Hint: this field may be ignored, applying the default value regardless. |
| shininess |
[shininess accessType inputOutput, type SFFloat CDATA "0.2"] [0,1]
Lower shininess values provide soft specular glows, while higher values result in
sharper, smaller highlights. Interchange profile
Hint: this field may be ignored, applying the default value regardless. |
| ambientIntensity |
[ambientIntensity accessType inputOutput, type SFFloat CDATA "0.2"] [0,1]
how much ambient omnidirectional light is reflected from all light sources. Interchange
profile
Hint: this field may be ignored, applying the default value regardless. |
| transparency |
[transparency accessType inputOutput, type SFFloat CDATA "0"] [0,1]
how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque.
Interchange profile
Hint: transparency < .5 opaque, transparency > .5 transparent. |
| containerField |
[containerField type NMTOKEN "material"]
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 |
unit |
(X3D version 3.3 or later) [X3D statement]
A unit statement defines data-conversion factors for typed values defined within
a scene.
Hint: unit statements are optional secondary children of head statement (add a head statement
and optionally any component elements first).
Hint: unit conversionFactor scale values only affect node definitions in the current Scene,
leaving Inline and ExternProtoDeclare content subject to their own independent unit
statements.
Hint: a good practice is to always include unit statements in CAD scenes in order to ensure
correct model composition.
Hint: X3D XML Encoding https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#Header
Warning: the UNIT statement is capitalized in the X3D Architecture specification and in the
X3D ClassicVRML Encoding.
Hint: X3D Architecture 7.2.5.5 UNIT statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#UNITStatement
Hint: International System of Units (SI), i.e. metric system https://en.wikipedia.org/wiki/International_System_of_Units
Hint: International System of Quantities (ISQ) https://en.wikipedia.org/wiki/International_System_of_Quantities
Hint: SI base unit https://en.wikipedia.org/wiki/SI_base_unit
Hint: SI derived unit https://en.wikipedia.org/wiki/SI_derived_unit
Hint: Metrology https://en.wikipedia.org/wiki/Metrology
Hint: X3D Scene Authoring Hints, Scale Factors and Unit Conversions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scale |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| name |
[name type NMTOKEN #REQUIRED]
Author-defined name for this unit conversionFactor value (for example, FeetToMeters).
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 |
| category |
[category type ENUMERATION #REQUIRED (angle|length|force|mass)]
Base-unit category as defined in X3D Specification.
Hint: unit category defaults are angle (radian), force (newton), length (meter), mass
(kilogram).
Hint: X3D Specification 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates |
| conversionFactor |
[conversionFactor type SFDouble #REQUIRED] [0,+β)
Positive double-precision factor that converts new base unit to default base unit.
Hint: X3D Scene Authoring Hints, Scale Factors and Unit Conversions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scale |
| 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 |
|
UniversalJoint |
(X3D version 3.2 or later) [inherits X3DRigidJointNode]
UniversalJoint is like a BallJoint that constrains an extra degree of rotational
freedom.
Contains two RigidBody nodes (containerField values body1, body2).
Hint: useful in combination with BallJoint.
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. |
| axis1 |
[axis1 accessType inputOutput, type SFVec3f CDATA "1 0 0"]
axis1 defines axis vector of joint connection to body1.
Hint: 0 0 0 means motor disabled about this axis. |
| axis2 |
[axis2 accessType inputOutput, type SFVec3f CDATA "0 1 0"]
axis2 defines axis vector of joint connection to body2.
Hint: 0 0 0 means motor disabled about this axis. |
| 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. |
| stop1Bounce |
[stop1Bounce accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stop1Bounce is velocity factor for bounce back once stop point is reached.
Hint: 0 means no bounce, 1 means return velocity matches. |
| stop2Bounce |
[stop2Bounce accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stop2Bounce is velocity factor for bounce back once stop point is reached.
Hint: 0 means no bounce, 1 means return velocity matches. |
| stop1ErrorCorrection |
[stop1ErrorCorrection accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stop1ErrorCorrection is fraction of error correction performed during time step
once stop point is reached.
Hint: 0 means no error correction, 1 means all error corrected in single step. |
| stop2ErrorCorrection |
[stop2ErrorCorrection accessType inputOutput, type SFFloat CDATA "1"] [0,1]
stop2ErrorCorrection is fraction of error correction performed during time step
once stop point is reached.
Hint: 0 means no error correction, 1 means all error corrected in single step. |
| 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. |
| body1Axis |
[body1Axis accessType outputOnly, type SFVec3f CDATA]
body1Axis describes report the current location of the anchor point relative to
the corresponding body. This can be used to determine if the joint has broken.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| body2Axis |
[body2Axis accessType outputOnly, type SFVec3f CDATA]
body1Axis describes report the current location of the anchor point relative to
the corresponding body. This can be used to determine if the joint has broken.
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 |
|
UnlitMaterial |
[inherits X3DOneSidedMaterialNode]
UnlitMaterial specifies surface rendering properties for associated geometry nodes.
Material attributes are used by the X3D lighting equations during rendering.
Hint: insert Shape and Appearance nodes before adding material.
Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related
shapes in a scene.
Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
Hint: X3D Example Archives, Basic, Universal Media Materials https://www.web3d.org/x3d/content/examples/Basic/UniversalMediaMaterials
Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/lighting.html#Lightingmodel
Hint: Rendering https://en.wikipedia.org/wiki/Rendering_(computer_graphics)
Hint: 3D rendering https://en.wikipedia.org/wiki/3D_rendering
Hint: Physically based rendering (PBR) https://en.wikipedia.org/wiki/Physically_based_rendering
Hint: Non-photorealistic rendering (NPR) https://en.wikipedia.org/wiki/Non-photorealistic_rendering
Hint: Cel shading (toon shading) https://en.wikipedia.org/wiki/Cel_shading |
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. |
| emissiveColor |
[emissiveColor accessType inputOutput, type SFColor CDATA "1 1 1"] [0,1]
how much glowing light is emitted from this object.
Hint: emissiveColors glow even when all lights are off.
Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
Warning: bright emissiveColor values can wash out other colors and some textures. |
| emissiveTexture |
[emissiveTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying emissiveColor for this material node, the contained texture provides
Physically Based Rendering (PBR) modulation for each pixel.
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='emissiveTexture' |
| emissiveTextureMapping |
[emissiveTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| normalScale |
[normalScale accessType inputOutput, type SFFloat CDATA "1"] [0,β]
normalScale controls the degree to which normalTexture RGB values apply XYZ-normal
bump mapping to pixels in the parent material.
Hint: normalScale only affects computation of normalTexture modulations that affect lighting
of characteristics of the parent Material and has no relation to normal vectors defined
by corresponding geometry.
Hint: normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping |
| normalTexture |
[normalTexture accessType inputOutput, type SFNode singleton, NULL node] [X3DSingleTextureNode]
When applying normalScale for this material node, the contained texture modulates
the texture across the surface.
Hint: normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping
Hint: if texture node is NULL or unspecified, no effect is applied to material values.
Hint: contained texture node must include containerField='normalTexture' |
| normalTextureMapping |
[normalTextureMapping accessType inputOutput, type NMTOKEN #IMPLIED]
The mapping label identifies which texture coordinates and transformations are used
to compute texture effects from corresponding geometry on a given material.
Hint: TODO support planned to perform multiple-node mapping validation checks using X3D
Schematron or X3D Validator https://savage.nps.edu/X3dValidator |
| transparency |
[transparency accessType inputOutput, type SFFloat CDATA "0"] [0,1]
how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque.
Interchange profile
Hint: transparency < .5 opaque, transparency > .5 transparent. |
| containerField |
[containerField type NMTOKEN "material"]
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 |
|
Viewpoint |
[inherits X3DViewpointNode]
Viewpoint provides a specific location and direction where the user may view the
scene. Viewpoints are the primary way for a user to navigate within a scene, and for
an author to show critical aspects of a model. Unless modified by the orientation
field, the default direction for a Viewpoint to look is along the -Z axis.
Hint: a sequence of good Viewpoints with understandable descriptions can provide a guided
tour of a model.
Hint: the currently bound NavigationInfo node has a major effect on how a user might change
viewing position and orientation after reaching this Viewpoint.
Hint: consider paired Viewpoint/NavigationInfo node combinations by defining ROUTE connections
between corresponding isBound/set_bind fields.
Hint: consider how users might interact with the current X3D model, either standalone
or as an Inline within a larger parent scene.
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.
Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more
than one of these nodes can be bound and 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.
Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch,
instead use ViewpointGroup as parent to constrain location proximity where the viewpoint
is available to user.
Hint: Regardless of viewpoint jump value at bind time, the relative viewing transformation
between user's view and defined position/orientation is stored for later use when
un-jumping (returning to the viewpoint when subsequent viewpoint is unbound).
Hint: customizable design pattern for dedicated Viewpoint/NavigationInfo pair: <Viewpoint
DEF='SpecialView'/> <NavigationInfo DEF='SpecialNav'/> <ROUTE fromNode='SpecialView'
fromField='isBound' toNode='SpecialNav' toField='set_bind'/>
Hint: X3D Scene Authoring Hints, Viewpoints https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Viewpoints |
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 |
| navigationInfo |
[navigationInfo accessType inputOutput, type SFNode singleton, NULL node] [NavigationInfo]
The navigationInfo field defines a dedicated NavigationInfo node for this X3DViewpointNode.
The specified NavigationInfo node receives a set_bind TRUE event at the time when
the parent node is bound and receives a set_bind FALSE at the time when the parent
node is unbound.
Hint: allows simple integration of custom navigation associated with each Viewpoint according
to user needs at that location. |
| viewAll |
[viewAll accessType inputOutput, type SFBool (true|false), false]
Viewpoint is automatically adjusted to view all visible geometry. Typically centerOfRotation
is shifted to center of current bounding box and view is zoomed in or out until all
visible objects are viewed.
Hint: no collision detection or proximity sensing occurs when zooming.
Warning: if needed, near and far clipping planes shall be adjusted to allow viewing the entire
scene.
Hint: when the value of the viewAll field is changed from TRUE to FALSE, no change in
the current view occurs. |
| 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 initializeOnly, type SFString CDATA #IMPLIED]
Text description or navigation hint to describe the significance of this model Viewpoint.
Hint: a sequence of good Viewpoints with understandable descriptions can provide a guided
tour of a model.
Hint: the currently bound NavigationInfo node has a major effect on how a user might change
viewing position and orientation after reaching this Viewpoint.
Hint: consider paired Viewpoint/NavigationInfo node combinations by defining ROUTE connections
between corresponding isBound/set_bind fields.
Hint: include space characters since a description is not a DEF identifier. Write short
phrases that make descriptions clear and readable.
Warning: without description, this Viewpoint is unlikely to appear on browser Viewpoint menus.
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). |
| farDistance |
[farDistance accessType inputOutput, type SFFloat CDATA "-1"] or (0,+β)
farDistance defines maximum clipping plane distance allowed for object display.
Hint: overrides bound NavigationInfo visibilityLimit value, if any.
Hint: default value -1 means no effect on currently defined view frustum boundaries.
Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
Warning: nearDistance must be less than farDistance. |
| nearDistance |
[nearDistance accessType inputOutput, type SFFloat CDATA "-1"] or (0,+β)
nearDistance defines minimum clipping plane distance necessary for object display.
Hint: overrides bound NavigationInfo avatarSize value, if any.
Hint: default value -1 means no effect on currently defined view frustum boundaries.
Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
Warning: nearDistance must be less than farDistance. |
| position |
[position accessType inputOutput, type SFVec3f CDATA "0 0 10"]
position (x, y, z in meters) relative to local coordinate system. |
| orientation |
[orientation accessType inputOutput, type SFRotation CDATA "0 0 1 0"]
Rotation (axis, angle in radians) of Viewpoint, relative to default -Z axis direction
in local coordinate system.
Hint: this is orientation _change_ from default direction (0 0 -1) along the -X axis.
Hint: complex rotations can be accomplished axis-by-axis using parent Transforms.
Warning: for VR/AR/MR/XR users wearing a head-mounted display (HMD), animating this field
may induce motion sickness. |
| centerOfRotation |
[centerOfRotation accessType inputOutput, type SFVec3f CDATA "0 0 0"]
centerOfRotation specifies center point about which to rotate user's eyepoint when
in EXAMINE or LOOKAT mode. |
| fieldOfView |
[fieldOfView accessType inputOutput, type SFFloat CDATA "0.7854" (0,Ο)]
Preferred minimum viewing angle from this viewpoint in radians, providing minimum
height or minimum width (whichever is smaller). Small field of view roughly corresponds
to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.
Hint: modifying Viewpoint distance to object may be better for zooming.
Warning: fieldOfView may not be correct for different window sizes and aspect ratios.
Warning: for VR/AR/MR/XR users wearing a head-mounted display (HMD), animating this field
may induce motion sickness. Interchange profile
Hint: this field may be ignored, applying the default value regardless. |
| jump |
[jump accessType inputOutput, type SFBool (true|false) "true"]
Transition instantly by jumping, otherwise smoothly adjust offsets in place when
changing to this Viewpoint.
Hint: see NavigationInfo.transitionType for the manner in which animated Viewpoint transistions
occur.
Hint: set jump=true for instantaneous camera motion when going to this viewpoint.
Warning: for VR/AR/MR/XR users wearing head-mounted displays, animating transitions between
viewpoints may induce motion sickness. |
| retainUserOffsets |
[retainUserOffsets accessType inputOutput, type SFBool (true|false) "false"]
Retain (true) or reset to zero (false) any prior user navigation offsets from defined
viewpoint position, orientation. |
| set_bind |
[set_bind accessType inputOnly, type SFBool #FIXED ""]
Sending event set_bind=true makes this node active. Sending event set_bind=false
makes this node inactive. Thus setting set_bind to true/false will pop/push (enable/disable)
this Viewpoint.
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 ""]
Output event true gets sent when node becomes bound and activated, otherwise output
event false gets sent when node becomes unbound and deactivated.
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 reporting timestamp 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 |
|
ViewpointGroup |
(X3D version 3.2 or later) [inherits X3DChildNode]
ViewpointGroup can contain Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup
nodes for better user-navigation support with a shared description on the viewpoint
list.
Hint: use ViewpointGroup as parent for Viewpoint, OrthoViewpoint, GeoViewpoint and other
ViewpointGroup nodes to constrain location proximity where contained viewpoints are
available to user.
Hint: ViewpointGroup and OrthoViewpoint require Navigation component level 3, which is
higher than CADInterchange profile.
Hint: Viewpoint and ViewpointGroup descriptions together build simple menu/submenu lists
for simple user navigation.
ViewpointGroup is not an X3DGroupingNode, and can only contain a Metadata* node, Viewpoint,
OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| children |
[children accessType inputOutput, type MFNode array, empty list] [X3DChildNode]
ViewpointGroup contains Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup
nodes that each have containerField='children' default value.
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. |
| description |
[description accessType initializeOnly, type SFString CDATA #IMPLIED]
Text description or navigation hint to identify this ViewpointGroup.
Hint: include space characters since a description is not a DEF identifier. Write short
phrases that make descriptions clear and readable.
Warning: without description, this ViewpointGroup is unlikely to appear on browser Viewpoint
menus.
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). |
| displayed |
[displayed accessType inputOutput, type SFBool (true|false) "true"]
displayed determines whether this ViewpointGroup is displayed in the current viewpoint
list. |
| center |
[center accessType inputOutput, type SFVec3f CDATA "0 0 0"]
center specifies center point of proximity box within which ViewpointGroup is usable
and displayed on viewpoint list. |
| size |
[size accessType inputOutput, type SFVec3f CDATA "0 0 0"] [0,+β)
size of Proximity box around center location, oriented within local transformation
frame, within which ViewpointGroup is usable and displayed on viewpoint list.
Hint: size 0 0 0 specifies that ViewpointGroup is always usable and displayable. |
| retainUserOffsets |
[retainUserOffsets accessType inputOutput, type SFBool (true|false) "false"]
Retain (true) or reset to zero (false) any prior user navigation offsets from defined
viewpoint position, orientation. |
| 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 |
|
Viewport |
(X3D version 3.2 or later) [inherits X3DViewportNode, implements X3DBoundedObject, X3DVisibleObject]
Viewport is a Grouping node that can contain most nodes. Viewport specifies a set
of rectangular clip boundaries against which the children nodes are clipped as they
are rendered. |
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. |
| clipBoundary |
[clipBoundary accessType inputOutput, type SFVec4f CDATA "0 1 0 1"] [0,1]
clipBoundary is specified in fractions of the normal render surface in the sequence
left/right/bottom/top. When children are rendered, the output will only appear in
the specified subset of the render surface.
Hint: default value 0 1 0 1 indicates 0-1 left-to-right and 0-1 bottom-to-top, meaning
full view. |
| 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 "viewport"]
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.
Warning: X3D Schema has incorrect default value for containerField.
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 |
VisibilitySensor |
[inherits X3DEnvironmentalSensorNode]
VisibilitySensor detects when user can see a specific object or region
as they navigate the world. The region sensed for visibility to the user is bounded
by a rectangular box.
Hint: often used to attract user attention or improve performance.
Hint: this sensor detects user interactions affecting peer nodes and their child geometry.
|
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. |
| 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. |
| center |
[center accessType inputOutput, type SFVec3f CDATA "0 0 0"]
Translation offset from origin of local coordinate system. |
| size |
[size accessType inputOutput, type SFVec3f CDATA "0 0 0"] [0,+β)
size of visibility box around center location, oriented within local transformation
frame. |
| isActive |
[isActive accessType outputOnly, type SFBool #FIXED ""]
isActive true/false events are sent when triggering the sensor. isActive=true when
entering visibility region, isActive=false when exiting visibility region.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| enterTime |
[enterTime accessType outputOnly, type SFTime CDATA #FIXED ""]
Time event generated when user's camera enters visibility region for sensor.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| exitTime |
[exitTime accessType outputOnly, type SFTime CDATA #FIXED ""]
Time event generated when user's camera exits visibility region for sensor.
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 |
|
VolumeData |
(X3D version 3.3 or later) [inherits X3DVolumeDataNode]
VolumeData displays a simple non-segmented voxel dataset with a single RenderStyle
node.
Hint: VolumeData can contain a single Texture3D node with containerField='voxels' and
a single RenderStyle node.
Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='1'/>
|
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] [X3DVolumeRenderStyleNode]
Single contained X3DVolumeRenderStyleNode node that defines specific rendering technique
for this volumetric object. If field is not defined, default is OpacityMapVolumeStyle
node. |
| voxels |
[voxels accessType inputOutput, type SFNode singleton, NULL node] [X3DTexture3DNode]
Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D)
that provides raw voxel information utilized by corresponding rendering styles. Any
number of color components (1-4) may be defined. |
| DEF |
[DEF type ID #IMPLIED]
DEF defines a unique ID name for this node, referenceable by other nodes.
Hint: descriptive DEF names improve clarity and help document a model.
Hint: well-defined names can simplify design and debugging through improved author understanding.
Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions |
| USE |
[USE type IDREF #IMPLIED]
USE means reuse an already DEF-ed node ID, excluding all child nodes and all other
attributes (except for containerField, which can have a different value).
Hint: USE references to previously defined DEF geometry (instead of duplicating nodes)
can improve performance.
Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except
for containerField) when defining a USE attribute.
Warning: each USE value must match a corresponding DEF value that is defined earlier in the
scene. |
| dimensions |
[dimensions accessType inputOutput, type SFVec3f CDATA "1 1 1"]
Actual-size X-Y-Z dimensions of volume data in local coordinate system. |
| 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 |
|
VolumeEmitter |
(X3D version 3.2 or later) [inherits X3DParticleEmitterNode]
VolumeEmitter emits particles from a random position confined within the given closed
geometry volume.
Hint: otherwise, a VolumeEmitter node acts like a PolylineEmitter node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/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. |
| coord |
[coord accessType inputOutput, type SFNode singleton, NULL node] [X3DCoordinateNode]
Coordinates for the geometry used as the emitting volume. |
| coordIndex |
[coordIndex accessType initializeOnly, type MFInt32 CDATA "-1"] [-1,+β)
coordIndex indices are applied to contained Coordinate values in order to define
randomly generated initial geometry of the particles.
Warning: coordIndex is required in order to connect contained coordinate point values. |
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "0 1 0"]
Initial direction from which particles emanate. |
| internal |
[internal accessType initializeOnly, type SFBool (true|false) "true"]
TODO, X3D specification is undefined. |
| mass |
[mass accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Basic mass of each particle, defined in mass base units (default is kilograms).
Hint: mass is needed if gravity or other force-related calculations are performed on a
per-particle basis.
Hint: https://en.wikipedia.org/wiki/Kilogram
Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates |
| on |
[on accessType inputOutput, type SFBool (true|false) "true"]
Enables/disables production of particles from this emitter node. If operating when
turned off, existing particles complete their rendering process. |
| speed |
[speed accessType inputOutput, type SFFloat CDATA "0"] [0,+β)
Initial linear speed (default is m/s) imparted to all particles along their direction
of movement. |
| surfaceArea |
[surfaceArea accessType initializeOnly, type SFFloat CDATA "0"] [0,+β)
Particle surface area in area base units (default is meters squared). Surface area
is used for calculations such as wind effects per particle.
Hint: surfaceArea value represents average frontal area presented to the wind.
Hint: assumes spherical model for each particle (i.e., surface area is the same regardless
of direction). |
| variation |
[variation accessType inputOutput, type SFFloat CDATA "0.25"] [0,+β)
Multiplier for the randomness used to control the range of possible output values.
The bigger the value, the more random the output and the bigger the range of possible
initial values possible.
Hint: variation of zero does not allow any randomness. |
| containerField |
[containerField type NMTOKEN "emitter"]
containerField is a field-label prefix indicating this node's field relationship
to its parent node, for example <Transform><Shape containerField='children'/></Transform>.
Hint: default containerField values for each node are correct in most cases, so the need
to override default containerField values is rare.
Hint: example values include containerField='geometry' for Box node, containerField='children'
for Group node, containerField='proxy' for hidden proxy shape within a Collision node,
etc.
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 |
|
VolumePickSensor |
(X3D version 3.2 or later) [inherits X3DPickSensorNode]
VolumePickSensor tests picking intersections using the pickingGeometry against the
pickTarget geometry volume.
Hint: sort order is based on distance between centers of the bounds of the picking geometry
and the picked geometry.
Warning: pickingGeometry volume is defined by the convex hull of the enclosing planes of
the provided X3DGeometryNode. If the provided volume is not manifold, pick results
are undefined.
Hint: a pick is successful if any vertex of the pickTarget geometry intersects the volume
defined by the pickingGeometry.
Hint: Sorting is defined based on distance between the centers of the bounds of the picking
geometry and the picked geometry.
Hint: picking is performed between rendered frames of the event model. An author sets
up the picking request in one frame by placing a LinePickSensor in the desired location.
At the start of the next frame, any picking intersections are reported by the pick
sensor.
Hint: picking notification is performed at the start of the frame for all enabled pick
sensors once all other sensors are processed.
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
Warning: order of contained nodes is significant, single pickingGeometry node must precede
pickTarget node array.
Hint: any geometry can be used for pickingGeometry node. |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| metadata |
[metadata accessType inputOutput, type SFNode singleton, NULL node] [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble,
MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata |
| pickingGeometry |
[pickingGeometry accessType inputOutput, type SFNode singleton, NULL node] [X3DGeometryNode]
pickingGeometry specifies the exact geometry coordinates that are used to perform
the intersection testing of the picking operation. |
| pickTarget |
[pickTarget accessType inputOutput, type MFNode array, empty list] [X3DGroupingNode | X3DShapeNode | Inline]
pickTarget specifies the list of nodes against which picking operations are performed.
All nodes declared in this field and their descendents are evaluated for intersections.
|
| pickedGeometry |
[pickedGeometry accessType outputOnly, type MFNode #FIXED ""]
Output event containing the node or nodes that have been found to intersect with
the picking geometry from the last time this node performed a picking operation, given
in the local coordinate system.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| 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 indicates when the intersecting object is picked by the picking geometry.
Output event isActive=true gets sent once a picked item is found. Output event isActive=false
gets sent once no picked item is found.
Warning: it is an error to define this transient outputOnly field in an X3D file, instead
only use it a source for ROUTE events. |
| intersectionType |
[intersectionType accessType initializeOnly, type SFString CDATA ( GEOMETRY|BOUNDS ) "BOUNDS"]
intersectionType specifies precision of the collision computation.
Hint: intersectionType constants may be extended by the browser to provide additional
options.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| matchCriterion |
[matchCriterion accessType inputOutput, type SFString CDATA ( MATCH_ANY|MATCH_EVERY|MATCH_ONLY_ONE ) "MATCH_ANY"]
defines whether the intersection test (i.e. pick) by this X3DPickSensorNode must
match one or more objectType. Specifically MATCH_ANY means any match of objectType
values is acceptable, MATCH_EVERY means that every objectType value in this node shall
match an objectType value in the X3DPickableObject, and MATCH_ONLY_ONE means that
one and only one objectType value can match. |
| objectType |
[objectType accessType inputOutput, type MFString CDATA ( ALL|NONE|TERRAIN|... ) "ALL"]
The objectType field specifies a set of labels used in the picking process. Each
string specified is treated as an independent label that needs to be matched against
the same type in one of the pick sensor instances.
Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to
intersect a pick sensor with objectType value "GROUND" fails since the objectType
values do not match.
Example: the special value "ALL" means that each node is available for picking regardless
of the type specified by the pick sensor.
Example: the special value "NONE" effectively disables all picking for this node and is the
equivalent of setting the pickable field of the corresponding PickableGroup to false.
Hint: authors may define any value for objectType.
Hint: MFString arrays can have multiple values, so "separate each individual string" "by
using quote marks". |
| sortOrder |
[sortOrder accessType initializeOnly, type SFString CDATA ( ANY|CLOSEST|ALL|ALL_SORTED|... ) "CLOSEST"]
The sortOrder field determines the order provided for picked output events.
Example: ANY means any single object that can satisfy picking conditions for this pick sensor.
Consistency of results is not guaranteed.
Example: ALL means that every object that satisfies the picking conditions for this pick
sensor shall be returned.
Example: ALL_SORTED means that every object that satisfies the picking conditions for this
pick sensor shall be returned with the order of the output fields provided in a distance-sorted
order from closest to farthest away. The exact algorithm for sorting is defined by
the individual node definitions.
Example: CLOSEST means that the closest object by distance that satisfies the conditions
of this pick sensor. *The exact algorithm for distance determination shall be defined
by individual node definitions*.
Hint: browser implementations may define additional values and algorithms beyond these
four required values.
Warning: do not wrap extra quotation marks around these SFString enumeration values, since
"quotation" "marks" are only used for MFString values. |
| 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 |
|
WaveShaper |
[inherits X3DSoundProcessingNode]
WaveShaper node represents a nonlinear distorter that applies a wave-shaping distortion
curve to the signal. Non-linear waveshaping distortion is commonly used for both subtle
non-linear warming, or more obvious distortion effects. Arbitrary non-linear shaping
curves may be specified.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#waveshapernode |
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. |
| curve |
[curve accessType inputOutput, type MFFloat CDATA ""]
The curve field is an array of floating-point numbers describing the distortion
to apply. |
| 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. |
| oversample |
[oversample accessType inputOutput, type SFString CDATA ( NONE|2X|4X ) NONE]
The oversample field is specifies what type of oversampling (if any) should be used
when applying the shaping curve. Allowed values follow. Note that for some applications,
avoiding oversampling can produce a precise shaping curve.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#enumdef-oversampletype |
| 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. |
| 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 |
|
WindPhysicsModel |
(X3D version 3.2 or later) [inherits X3DParticlePhysicsModelNode]
WindPhysicsModel applies a wind effect to the particles. The wind includes a random
variation factor to model gustiness. |
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. |
| direction |
[direction accessType inputOutput, type SFVec3f CDATA "1 0 0"]
direction in which wind is travelling in the form of a normalized, unit vector.
|
| gustiness |
[gustiness accessType inputOutput, type SFFloat CDATA "0.1"] [0,+β)
gustiness specifies how much wind speed varies from the average speed.
Hint: wind speed variation is calculated once per frame and applied equally to all particles.
|
| speed |
[speed accessType inputOutput, type SFFloat CDATA "0.1"] [0,+β)
Initial linear speed (default is m/s) imparted to all particles along their direction
of movement. |
| turbulence |
[turbulence accessType inputOutput, type SFFloat CDATA "0.1"] [0,1]
turbulence field specifies how much the wind acts directly in line with the direction,
and how much variation is applied in directions other than the wind direction.
Hint: this is determined per-particle to model how each is effected by turbulence. |
| 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 |
WorldInfo |
[inherits X3DInfoNode]
WorldInfo incldes a browsesr-displayable title and persistent string information
about an X3D scene. For X3D4 models, WorldInfo can also contain a single MetadataSet
node with further metadata information about the scene.
Hint: comments are not readable when a model file is loaded for viewing, but WorldInfo
and Metadata* nodes are persistent and inspectable at run time.
Hint: WorldInfo is part of Core component and Core profile. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#t-CoresupportLevels
Hint: X3D for Web Authors, Chapter 15, Metadata Information https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.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. |
| title |
[title accessType inputOutput, type SFString CDATA #IMPLIED]
title of this world, placed in window title.
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). |
| info |
[info accessType inputOutput, type MFString CDATA #IMPLIED]
Additional information about this model.
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: 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). |
| 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 |
|
X3D |
[X3D statement]
X3D is the top-most XML element for an Extensible 3D (X3D) Graphics model.
The X3D element contains a single head element for metadata, and a single Scene element
which is root node of the 3D scene graph.
Hint: for more on XML declaration and DOCTYPE (DTD) statements, which precede the X3D
statement, see https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Validation
Hint: each X3D model has a tree structure. Wikipedia: Tree (data structure) https://en.wikipedia.org/wiki/Tree_(data_structure)
Hint: X3D model is also a form of Directed Acyclic Graph (DAG), which has no loops and
helps to ensure efficient processing.
Hint: additional attributes are under consideration for use when embedding X3D version
4 scenes within HTML version 5 web pages.
Hint: X3D Architecture 7.2.5.2 Header statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#HeaderStatement |
Search
mail lists or
Mantis issues, give feedback |
X3D validation:
XML Schema, DOCTYPE, JSON Schema, Java SAI, X3DJSAIL |
| head |
[X3D statement head]
Include a head element to contain component, unit or meta statements for this X3D
model. |
| Scene |
[X3D statement Scene]
Include a Scene element to contain scene-graph nodes for this X3D model.
Warning: Scene is a child of X3D statement, and must follow the (optional) head statement.
|
| version |
[version type ENUMERATION #REQUIRED (3.0|3.1|3.2|3.3|4.0)]
Default is highest value matching schema and DOCTYPE in the scene.
Hint: X3D version 3.0 standardization occurred in 2004, version 3.1 standardization occurred
in 2006, version 3.2 standardization occurred in 2008, version 3.3 standardization
occurred in 2012, version 4.0 successfully completed implementation, evaluatio,n and
publication in 2023.
Warning: X3D version 4.1 is experimental and not yet under development.
Hint: X3D version 4 Overview at https://www.web3d.org/x3d4
Hint: X3D version 4 Implementations Status at https://www.web3d.org/x3dv4-implementations |
| profile |
[profile type ENUMERATION #REQUIRED (Core|Interchange|CADInterchange|Interactive|Immersive|MPEG4Interactive|MedicalInterchange|Full)]
profile attribute is required and defines the player or tool support needed for
this model.
Hint: Core profile corresponds to minimalist extensible profile with Metadata* nodes,
useful for defining custom scene capabilities via addition of individual component
statements. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/coreprofile.html
Hint: Interchange profile corresponds to minimum lightweight subset of nodes needed to
display (or import/export) compelling 3D content. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/interchange.html
Hint: Interactive profile corresponds to Interchange geometry plus simple user interaction.
https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/interactive.html
Hint: Immersive profile is common and approximately matches VRML97 with Script and Prototypes.
https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/immersive.html
Hint: CADInterchange profile (X3D version 3.1 or later) corresponds to Interchange geometry
plus distillation of computer-aided design (CAD) models. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/CADInterchange.html
Hint: MedicalInterchange profile (X3D version 3.3 or later) adds support for VolumeRendering
component to Interchange profile. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/MedicalInterchange.html
Hint: Full profile contains all nodes defined in X3D specification. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/fullProfile.html
Warning: PROFILE is capitalized and is a separate statement in the ClassicVRML Encoding.
Hint: X3D Architecture 7.2.5.3 PROFILE statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#PROFILEStatement |
| xmlns:xsd |
[xmlns:xsd type CDATA "http://www.w3.org/2001/XMLSchema-instance"]
XML namespace (xmlns) for XML Schema Definition (xsd).
Hint: X3D Scene Authoring Hints, Validation of X3D Scenes using DTD and XML Schema https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Validation |
| xsd:noNamespaceSchemaLocation |
[xsd:noNamespaceSchemaLocation type CDATA "https://www.web3d.org/specifications/x3d-3.3.xsd"]
url for the X3D Schema defining the X3D document-validation rules.
Hint: X3D Scene Authoring Hints, Validation of X3D Scenes using DTD and XML Schema https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Validation |
| 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 |
