org.web3d.x3d.jsail.EnvironmentalEffects

Class FogObject

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.EnvironmentalEffects.FogObject

All Implemented Interfaces:

X3DBindableNode, X3DChildNode, X3DNode, Fog, X3DFogObject

public class FogObject
extends X3DConcreteNode
implements Fog

X3D node tooltip: [X3DBindableNode,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.

Note that SFColorObject provides a variety of color constants.

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:

X3D Abstract Specification: Fog, X3D Tooltips: Fog, X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field and Description
static float[]	COLOR_DEFAULT_VALUE SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
static java.lang.String	COMPONENT String constant COMPONENT defines X3D component for the Fog element: EnvironmentalEffects
static java.lang.String	containerField_DEFAULT_VALUE containerField describes typical field relationship of a node to its parent.
static java.lang.String	FOGTYPE_DEFAULT_VALUE SFString field named fogType has default value "LINEAR" (Java syntax) or LINEAR (XML syntax).
static java.lang.String	FOGTYPE_EXPONENTIAL SFString field named fogType can equal this enumeration value "EXPONENTIAL" (Java syntax) or EXPONENTIAL (XML syntax).
static java.lang.String	FOGTYPE_LINEAR SFString field named fogType can equal this enumeration value "LINEAR" (Java syntax) or LINEAR (XML syntax).
static java.lang.String	fromField_BINDTIME fromField ROUTE name for SFTime field named bindTime.
static java.lang.String	fromField_COLOR fromField ROUTE name for SFColor field named color.
static java.lang.String	fromField_FOGTYPE fromField ROUTE name for SFString field named fogType.
static java.lang.String	fromField_ISBOUND fromField ROUTE name for SFBool field named isBound.
static java.lang.String	fromField_METADATA fromField ROUTE name for SFNode field named metadata.
static java.lang.String	fromField_VISIBILITYRANGE fromField ROUTE name for SFFloat field named visibilityRange.
static int	LEVEL Integer constant LEVEL provides default X3D EnvironmentalEffects component level for this element: 2
static java.lang.String	NAME String constant NAME provides name of this element: Fog.
static java.lang.String	toField_COLOR toField ROUTE name for SFColor field named color.
static java.lang.String	toField_FOGTYPE toField ROUTE name for SFString field named fogType.
static java.lang.String	toField_METADATA toField ROUTE name for SFNode field named metadata.
static java.lang.String	toField_SET_BIND toField ROUTE name for SFBool field named set_bind.
static java.lang.String	toField_VISIBILITYRANGE toField ROUTE name for SFFloat field named visibilityRange.
static float	VISIBILITYRANGE_DEFAULT_VALUE SFFloat field named visibilityRange has default value 0f (Java syntax) or 0 (XML syntax).

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

validationResult

Constructor Summary

Constructors

Constructor and Description
FogObject() Constructor for FogObject to initialize member variables with default values.
FogObject(java.lang.String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method and Description
FogObject	addComments(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.
FogObject	addComments(java.lang.String newComment) Add comment as String to contained commentsList.
FogObject	addComments(java.lang.String[] newComments) Add comments as String[] array to contained commentsList.
FogObject	clearMetadata() Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(java.lang.String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
java.lang.String	getAccessType(java.lang.String fieldName) Indicate accessType corresponding to given fieldName.
double	getBindTime() Provide double value in seconds from outputOnly SFTime field named bindTime.
float[]	getColor() Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.
java.lang.String	getComponent() Defines X3D component for the Fog element: EnvironmentalEffects
int	getComponentLevel() Provides default X3D component level for this element: 2
java.lang.String	getContainerFieldDefault() containerField describes typical field relationship of a node to its parent.
java.lang.String	getElementName() Provides name of this element: Fog
java.lang.String	getFieldType(java.lang.String fieldName) Indicate type corresponding to given fieldName.
java.lang.String	getFogType() Provide String enumeration value ['LINEAR'|'EXPONENTIAL'] from inputOutput SFString field named fogType.
ISObject	getIS() Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
boolean	getIsBound() Provide boolean value from outputOnly SFBool field named isBound.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getVisibilityRange() Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named visibilityRange.
boolean	hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasMetadata() Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(java.lang.String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
void	initialize() Initialize all member variables to default values.
FogObject	setColor(float[] newValue) Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to inputOutput SFColor field named color.
FogObject	setColor(float red, float green, float blue) Assign values to SFColor color field, similar to setColor(float[]).
FogObject	setColor(SFColorObject newValue) Assign typed object value to SFColor color field, similar to setColor(float[]).
FogObject	setCssClass(SFStringObject newValue) Assign typed object value to SFString cssClass field, similar to setCssClass(String).
FogObject	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
FogObject	setDEF(SFStringObject newValue) Assign typed object value to SFString DEF field, similar to setDEF(String).
FogObject	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
FogObject	setFogType(SFStringObject newValue) Assign typed object value to SFString fogType field, similar to setFogType(String).
FogObject	setFogType(java.lang.String newValue) Assign String enumeration value ("LINEAR"|"EXPONENTIAL") ['LINEAR'|'EXPONENTIAL'] to inputOutput SFString field named fogType.
FogObject	setIS(ISObject newValue) Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
FogObject	setMetadata(ProtoInstanceObject newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
FogObject	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
FogObject	setUSE(FogObject DEFnode) Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
FogObject	setUSE(SFStringObject newValue) Assign typed object value to SFString USE field, similar to setUSE(String).
FogObject	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.
FogObject	setVisibilityRange(float newValue) Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named visibilityRange.
FogObject	setVisibilityRange(SFFloatObject newValue) Assign typed object value to SFFloat visibilityRange field, similar to setVisibilityRange(float).
java.lang.String	toStringClassicVRML(int indentLevel) Recursive method to provide ClassicVRML string serialization.
java.lang.String	toStringVRML97(int indentLevel) Recursive method to provide VRML97 string serialization.
java.lang.String	toStringX3D(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
java.lang.String	validate() Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FOGTYPE_LINEAR

public static final java.lang.String FOGTYPE_LINEAR

SFString field named fogType can equal this enumeration value "LINEAR" (Java syntax) or LINEAR (XML syntax).

See Also:

Constant Field Values

FOGTYPE_EXPONENTIAL

public static final java.lang.String FOGTYPE_EXPONENTIAL

SFString field named fogType can equal this enumeration value "EXPONENTIAL" (Java syntax) or EXPONENTIAL (XML syntax).

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

String constant NAME provides name of this element: Fog.

See Also:

Constant Field Values

COMPONENT

public static final java.lang.String COMPONENT

String constant COMPONENT defines X3D component for the Fog element: EnvironmentalEffects

See Also:

Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D EnvironmentalEffects component level for this element: 2

See Also:

Constant Field Values

COLOR_DEFAULT_VALUE

public static final float[] COLOR_DEFAULT_VALUE

SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).

FOGTYPE_DEFAULT_VALUE

public static final java.lang.String FOGTYPE_DEFAULT_VALUE

SFString field named fogType has default value "LINEAR" (Java syntax) or LINEAR (XML syntax).

See Also:

Constant Field Values

VISIBILITYRANGE_DEFAULT_VALUE

public static final float VISIBILITYRANGE_DEFAULT_VALUE

SFFloat field named visibilityRange has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

Constant Field Values

containerField_DEFAULT_VALUE

public static final java.lang.String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.

See Also:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values

fromField_BINDTIME

public static final java.lang.String fromField_BINDTIME

fromField ROUTE name for SFTime field named bindTime.

See Also:

Constant Field Values

fromField_COLOR

public static final java.lang.String fromField_COLOR

fromField ROUTE name for SFColor field named color.

See Also:

Constant Field Values

toField_COLOR

public static final java.lang.String toField_COLOR

toField ROUTE name for SFColor field named color.

See Also:

Constant Field Values

fromField_FOGTYPE

public static final java.lang.String fromField_FOGTYPE

fromField ROUTE name for SFString field named fogType.

See Also:

Constant Field Values

toField_FOGTYPE

public static final java.lang.String toField_FOGTYPE

toField ROUTE name for SFString field named fogType.

See Also:

Constant Field Values

fromField_ISBOUND

public static final java.lang.String fromField_ISBOUND

fromField ROUTE name for SFBool field named isBound.

See Also:

Constant Field Values

fromField_METADATA

public static final java.lang.String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

toField_METADATA

public static final java.lang.String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

toField_SET_BIND

public static final java.lang.String toField_SET_BIND

toField ROUTE name for SFBool field named set_bind.

See Also:

Constant Field Values

fromField_VISIBILITYRANGE

public static final java.lang.String fromField_VISIBILITYRANGE

fromField ROUTE name for SFFloat field named visibilityRange.

See Also:

Constant Field Values

toField_VISIBILITYRANGE

public static final java.lang.String toField_VISIBILITYRANGE

toField ROUTE name for SFFloat field named visibilityRange.

See Also:

Constant Field Values

Constructor Detail

FogObject

public FogObject()

Constructor for FogObject to initialize member variables with default values.

FogObject

public FogObject(java.lang.String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Detail

getElementName

public final java.lang.String getElementName()

Provides name of this element: Fog

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final java.lang.String getComponent()

Defines X3D component for the Fog element: EnvironmentalEffects

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 2

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public java.lang.String getFieldType(java.lang.String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public java.lang.String getAccessType(java.lang.String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final java.lang.String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getBindTime

public double getBindTime()

Provide double value in seconds from outputOnly SFTime field named bindTime.

Tooltip: Event sent reporting timestamp when node becomes active/inactive.

• Warning: it is an error to define this transient outputOnly field in an X3D file.

Specified by:

getBindTime in interface X3DBindableNode

Specified by:

getBindTime in interface Fog

Returns:

value of bindTime field

getColor

public float[] getColor()

Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.

Tooltip: [0,1] Fog color.

• Hint: match Background color to make objects fade away.
• Hint: X3D Scene Authoring Hints, Color
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

getColor in interface Fog

Specified by:

getColor in interface X3DFogObject

Returns:

value of color field

setColor

public FogObject setColor(float[] newValue)

Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to inputOutput SFColor field named color.

Tooltip: [0,1] Fog color. Hint: match Background color to make objects fade away. Hint: X3D Scene Authoring Hints, Color http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

setColor in interface Fog

Specified by:

setColor in interface X3DFogObject

Parameters:

newValue - is new value for the color field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setColor

public FogObject setColor(SFColorObject newValue)

Assign typed object value to SFColor color field, similar to setColor(float[]).

Parameters:

newValue - is new value for the color field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setColor

public FogObject setColor(float red,
                          float green,
                          float blue)

Assign values to SFColor color field, similar to setColor(float[]).

Parameters:

red - first component

green - second component

blue - third component

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getFogType

public java.lang.String getFogType()

Provide String enumeration value ['LINEAR'|'EXPONENTIAL'] from inputOutput SFString field named fogType.

Tooltip: 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.

Available enumeration values for string comparison: LINEAR, EXPONENTIAL.

Specified by:

getFogType in interface Fog

Specified by:

getFogType in interface X3DFogObject

Returns:

value of fogType field

setFogType

public FogObject setFogType(java.lang.String newValue)

Assign String enumeration value ("LINEAR"|"EXPONENTIAL") ['LINEAR'|'EXPONENTIAL'] to inputOutput SFString field named fogType.

Warning: authors can only choose from a strict list of enumeration values (LINEAR, EXPONENTIAL).

Tooltip: 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.

Specified by:

setFogType in interface Fog

Specified by:

setFogType in interface X3DFogObject

Parameters:

newValue - is new value for the fogType field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setFogType

public FogObject setFogType(SFStringObject newValue)

Assign typed object value to SFString fogType field, similar to setFogType(String).

Parameters:

newValue - is new value for the fogType field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getIsBound

public boolean getIsBound()

Provide boolean value from outputOnly SFBool field named isBound.

Tooltip: 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.

Specified by:

getIsBound in interface X3DBindableNode

Specified by:

getIsBound in interface Fog

Returns:

value of isBound field

getMetadata

public X3DMetadataObject getMetadata()

Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface X3DBindableNode

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface Fog

Returns:

value of metadata field

See Also:

getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public FogObject setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DBindableNode

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface Fog

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public FogObject clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public FogObject setMetadata(ProtoInstanceObject newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

setMetadata(X3DMetadataObject)

hasMetadata

public boolean hasMetadata()

Indicate whether an object is available for inputOutput SFNode field metadata.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

getVisibilityRange

public float getVisibilityRange()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named visibilityRange.

Tooltip: Distance in meters where objects are totally obscured by the fog, using local coordinate system.

• Hint: visibilityRange 0 disables Fog.

Specified by:

getVisibilityRange in interface Fog

Specified by:

getVisibilityRange in interface X3DFogObject

Returns:

value of visibilityRange field

setVisibilityRange

public FogObject setVisibilityRange(float newValue)

Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named visibilityRange.

Tooltip: Distance in meters where objects are totally obscured by the fog, using local coordinate system. Hint: visibilityRange 0 disables Fog.

Specified by:

setVisibilityRange in interface Fog

Specified by:

setVisibilityRange in interface X3DFogObject

Parameters:

newValue - is new value for the visibilityRange field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setVisibilityRange

public FogObject setVisibilityRange(SFFloatObject newValue)

Assign typed object value to SFFloat visibilityRange field, similar to setVisibilityRange(float).

Parameters:

newValue - is new value for the visibilityRange field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public final FogObject setDEF(java.lang.String newValue)

Assign String value to inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DBindableNode

Specified by:

setDEF in interface X3DChildNode

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in interface Fog

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public FogObject setDEF(SFStringObject newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public final FogObject setUSE(java.lang.String newValue)

Assign String value to inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.

Specified by:

setUSE in interface X3DBindableNode

Specified by:

setUSE in interface X3DChildNode

Specified by:

setUSE in interface X3DNode

Specified by:

setUSE in interface Fog

Specified by:

setUSE in class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public FogObject setUSE(SFStringObject newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCssClass

public final FogObject setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS

Specified by:

setCssClass in interface X3DBindableNode

Specified by:

setCssClass in interface X3DChildNode

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in interface Fog

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

W3C Cascading Style Sheets

setCssClass

public FogObject setCssClass(SFStringObject newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setIS

public FogObject setIS(ISObject newValue)

Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the description field.

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

getIS

public ISObject getIS()

Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

getIS in class X3DConcreteNode

Returns:

current ISObject, if any.

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

setUSE

public FogObject setUSE(FogObject DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.

Parameters:

DEFnode - must have a DEF value defined

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public FogObject addComments(java.lang.String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public FogObject addComments(java.lang.String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public FogObject addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

FogObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public java.lang.String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form

toStringClassicVRML

public java.lang.String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public java.lang.String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found element, null otherwise

See Also:

findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

object reference to found element, null otherwise

See Also:

findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasElementByNameValue

public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

whether node is found

See Also:

findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same DEF, this method does not handle that case.

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found node, null otherwise

See Also:

findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasNodeByDEF

public boolean hasNodeByDEF(java.lang.String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

whether node is found

See Also:

findNodeByDEF(String)

validate

public java.lang.String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)