Package org.web3d.x3d.jsail.Shape
Class AppearanceObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Shape.AppearanceObject
- All Implemented Interfaces:
X3DNode
,Appearance
,X3DAppearanceNode
public class AppearanceObject extends X3DConcreteNode implements Appearance
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.
X3D node tooltip: [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.
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.
X3D node tooltip: [X3DAppearanceNode] Appearance specifies the visual properties of geometry by containing the Material, ImageTexture/MovieTexture/PixelTexture, FillProperties, LineProperties, programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) and TextureTransform nodes.
- Hint: insert a Shape node before adding geometry or Appearance. Interchange profile hint: only Material and ImageTexture children are allowed.
- Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
- Hint: Advanced uses can contain MultiTexture, MultiTextureTransform/TextureTransformMatrix3D/TextureTransform3D, ComposedShader/PackagedShader/ProgramShader, ComposedTexture3D/ImageTexture3D/PixelTexture3D, or ComposedCubeMapTexture/GeneratedCubeMapTexture/ImageCubeMapTexture.
- Hint: X3D Architecture 12.2.2 Appearance node https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shape.html#Appearancenode
- Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/lighting.html#Lightingmodel
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.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the Appearance element: Shapestatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static FillPropertiesObject
FILLPROPERTIES_DEFAULT_VALUE
SFNode field named fillProperties has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
fromField_FILLPROPERTIES
fromField ROUTE name for SFNode field named fillProperties.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_LINEPROPERTIES
fromField ROUTE name for SFNode field named lineProperties.static java.lang.String
fromField_MATERIAL
fromField ROUTE name for SFNode field named material.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_POINTPROPERTIES
fromField ROUTE name for SFNode field named pointProperties.static java.lang.String
fromField_SHADERS
fromField ROUTE name for MFNode field named shaders.static java.lang.String
fromField_TEXTURE
fromField ROUTE name for SFNode field named texture.static java.lang.String
fromField_TEXTURETRANSFORM
fromField ROUTE name for SFNode field named textureTransform.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Shape component level for this element: 1static LinePropertiesObject
LINEPROPERTIES_DEFAULT_VALUE
SFNode field named lineProperties has default value null (Java syntax) or NULL (XML syntax).static X3DMaterialNode
MATERIAL_DEFAULT_VALUE
SFNode field named material has default value null (Java syntax) or NULL (XML syntax).static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: Appearance.static PointPropertiesObject
POINTPROPERTIES_DEFAULT_VALUE
SFNode field named pointProperties has default value null (Java syntax) or NULL (XML syntax).static X3DTextureNode
TEXTURE_DEFAULT_VALUE
SFNode field named texture has default value null (Java syntax) or NULL (XML syntax).static X3DTextureTransformNode
TEXTURETRANSFORM_DEFAULT_VALUE
SFNode field named textureTransform has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
toField_FILLPROPERTIES
toField ROUTE name for SFNode field named fillProperties.static java.lang.String
toField_LINEPROPERTIES
toField ROUTE name for SFNode field named lineProperties.static java.lang.String
toField_MATERIAL
toField ROUTE name for SFNode field named material.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_POINTPROPERTIES
toField ROUTE name for SFNode field named pointProperties.static java.lang.String
toField_SHADERS
toField ROUTE name for MFNode field named shaders.static java.lang.String
toField_TEXTURE
toField ROUTE name for SFNode field named texture.static java.lang.String
toField_TEXTURETRANSFORM
toField ROUTE name for SFNode field named textureTransform.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description AppearanceObject()
Constructor for AppearanceObject to initialize member variables with default values.AppearanceObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description AppearanceObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.AppearanceObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.AppearanceObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.AppearanceObject
addShaders(ProtoInstanceObject newValue)
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for shaders field.AppearanceObject
addShaders(X3DNode newValue)
Add single child node to existing array of shaders nodes (if any).void
addShaders(X3DNode[] newValue)
Add array of child shaders nodes to array of existing nodes (if any).AppearanceObject
clearFillProperties()
Utility method to clear SFNode value of fillProperties field.AppearanceObject
clearIS()
Utility method to clear SFNode value of IS field.AppearanceObject
clearLineProperties()
Utility method to clear SFNode value of lineProperties field.AppearanceObject
clearMaterial()
Utility method to clear SFNode value of material field.AppearanceObject
clearMetadata()
Utility method to clear SFNode value of metadata field.AppearanceObject
clearPointProperties()
Utility method to clear SFNode value of pointProperties field.AppearanceObject
clearShaders()
Utility method to clear MFNode value of shaders field.AppearanceObject
clearTexture()
Utility method to clear SFNode value of texture field.AppearanceObject
clearTextureTransform()
Utility method to clear SFNode value of textureTransform 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.java.lang.String
getComponent()
Defines X3D component for the Appearance element: Shapeint
getComponentLevel()
Provides default X3D component level for this element: 1java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: Appearancejava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.FillProperties
getFillProperties()
Provide FillPropertiesObject instance (using a properly typed node) from inputOutput SFNode field fillProperties.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.LineProperties
getLineProperties()
Provide LinePropertiesObject instance (using a properly typed node) from inputOutput SFNode field lineProperties.X3DMaterialNode
getMaterial()
Provide X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.PointProperties
getPointProperties()
Provide PointPropertiesObject instance (using a properly typed node) from inputOutput SFNode field pointProperties.X3DNode[]
getShaders()
Provide array of X3DShaderNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field shaders.java.util.ArrayList<X3DNode>
getShadersList()
Utility method to get ArrayList value of MFNode shaders field, similar togetShaders()
.X3DTextureNode
getTexture()
Provide X3DTextureNode instance (using a properly typed node) from inputOutput SFNode field texture.X3DTextureTransformNode
getTextureTransform()
Provide X3DTextureTransformNode instance (using a properly typed node) from inputOutput SFNode field textureTransform.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.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
hasFillProperties()
Indicate whether an object is available for inputOutput SFNode field fillProperties.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
hasLineProperties()
Indicate whether an object is available for inputOutput SFNode field lineProperties.boolean
hasMaterial()
Indicate whether an object is available for inputOutput SFNode field material.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.boolean
hasPointProperties()
Indicate whether an object is available for inputOutput SFNode field pointProperties.boolean
hasShaders()
Indicate whether an object is available for inputOutput MFNode field shaders.boolean
hasTexture()
Indicate whether an object is available for inputOutput SFNode field texture.boolean
hasTextureTransform()
Indicate whether an object is available for inputOutput SFNode field textureTransform.void
initialize()
Initialize all member variables to default values.AppearanceObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.AppearanceObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.AppearanceObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.AppearanceObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.AppearanceObject
setFillProperties(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fillProperties.AppearanceObject
setFillProperties(FillProperties newValue)
Accessor method to assign FillPropertiesObject instance (using a properly typed node) to inputOutput SFNode field fillProperties.AppearanceObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.AppearanceObject
setLineProperties(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field lineProperties.AppearanceObject
setLineProperties(LineProperties newValue)
Accessor method to assign LinePropertiesObject instance (using a properly typed node) to inputOutput SFNode field lineProperties.AppearanceObject
setMaterial(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field material.AppearanceObject
setMaterial(X3DMaterialNode newValue)
Accessor method to assign X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.AppearanceObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.AppearanceObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.AppearanceObject
setPointProperties(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field pointProperties.AppearanceObject
setPointProperties(PointProperties newValue)
Accessor method to assign PointPropertiesObject instance (using a properly typed node) to inputOutput SFNode field pointProperties.AppearanceObject
setShaders(java.util.ArrayList<X3DShaderNode> newValue)
Assign ArrayList value of MFNode shaders field, similar tosetShaders(X3DNode[])
.void
setShaders(X3DNode newValue)
Set single child shaders node, replacing prior array of existing nodes (if any).AppearanceObject
setShaders(X3DNode[] newValue)
Accessor method to assign X3DShaderNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field shaders.AppearanceObject
setTexture(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texture.AppearanceObject
setTexture(X3DTextureNode newValue)
Accessor method to assign X3DTextureNode instance (using a properly typed node) to inputOutput SFNode field texture.AppearanceObject
setTextureTransform(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field textureTransform.AppearanceObject
setTextureTransform(X3DTextureTransformNode newValue)
Accessor method to assign X3DTextureTransformNode instance (using a properly typed node) to inputOutput SFNode field textureTransform.AppearanceObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.AppearanceObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.AppearanceObject
setUSE(AppearanceObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.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, 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, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: Appearance.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the Appearance element: Shape- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Shape component level for this element: 1- See Also:
- Constant Field Values
-
FILLPROPERTIES_DEFAULT_VALUE
SFNode field named fillProperties has default value null (Java syntax) or NULL (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
LINEPROPERTIES_DEFAULT_VALUE
SFNode field named lineProperties has default value null (Java syntax) or NULL (XML syntax). -
MATERIAL_DEFAULT_VALUE
SFNode field named material has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
POINTPROPERTIES_DEFAULT_VALUE
SFNode field named pointProperties has default value null (Java syntax) or NULL (XML syntax). -
TEXTURE_DEFAULT_VALUE
SFNode field named texture has default value null (Java syntax) or NULL (XML syntax). -
TEXTURETRANSFORM_DEFAULT_VALUE
SFNode field named textureTransform has default value null (Java syntax) or NULL (XML syntax). -
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField 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. -
fromField_FILLPROPERTIES
public static final java.lang.String fromField_FILLPROPERTIESfromField ROUTE name for SFNode field named fillProperties.- See Also:
- Constant Field Values
-
toField_FILLPROPERTIES
public static final java.lang.String toField_FILLPROPERTIEStoField ROUTE name for SFNode field named fillProperties.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_LINEPROPERTIES
public static final java.lang.String fromField_LINEPROPERTIESfromField ROUTE name for SFNode field named lineProperties.- See Also:
- Constant Field Values
-
toField_LINEPROPERTIES
public static final java.lang.String toField_LINEPROPERTIEStoField ROUTE name for SFNode field named lineProperties.- See Also:
- Constant Field Values
-
fromField_MATERIAL
public static final java.lang.String fromField_MATERIALfromField ROUTE name for SFNode field named material.- See Also:
- Constant Field Values
-
toField_MATERIAL
public static final java.lang.String toField_MATERIALtoField ROUTE name for SFNode field named material.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_POINTPROPERTIES
public static final java.lang.String fromField_POINTPROPERTIESfromField ROUTE name for SFNode field named pointProperties.- See Also:
- Constant Field Values
-
toField_POINTPROPERTIES
public static final java.lang.String toField_POINTPROPERTIEStoField ROUTE name for SFNode field named pointProperties.- See Also:
- Constant Field Values
-
fromField_SHADERS
public static final java.lang.String fromField_SHADERSfromField ROUTE name for MFNode field named shaders.- See Also:
- Constant Field Values
-
toField_SHADERS
public static final java.lang.String toField_SHADERStoField ROUTE name for MFNode field named shaders.- See Also:
- Constant Field Values
-
fromField_TEXTURE
public static final java.lang.String fromField_TEXTUREfromField ROUTE name for SFNode field named texture.- See Also:
- Constant Field Values
-
toField_TEXTURE
public static final java.lang.String toField_TEXTUREtoField ROUTE name for SFNode field named texture.- See Also:
- Constant Field Values
-
fromField_TEXTURETRANSFORM
public static final java.lang.String fromField_TEXTURETRANSFORMfromField ROUTE name for SFNode field named textureTransform.- See Also:
- Constant Field Values
-
toField_TEXTURETRANSFORM
public static final java.lang.String toField_TEXTURETRANSFORMtoField ROUTE name for SFNode field named textureTransform.- See Also:
- Constant Field Values
-
-
Constructor Details
-
AppearanceObject
public AppearanceObject()Constructor for AppearanceObject to initialize member variables with default values. -
AppearanceObject
public AppearanceObject(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 Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: Appearance- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the Appearance element: Shape- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- 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 classX3DConcreteElement
- 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 classX3DConcreteElement
- 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 classX3DConcreteNode
- 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 classX3DConcreteNode
-
getFillProperties
Provide FillPropertiesObject instance (using a properly typed node) from inputOutput SFNode field fillProperties.- Specified by:
getFillProperties
in interfaceAppearance
- Returns:
- value of fillProperties field
- See Also:
Tooltip: [FillProperties] Single contained FillProperties node that specifies additional visual attributes applied to polygonal areas of corresponding geometry, on top of whatever other appearance is already defined. *
-
setFillProperties
Accessor method to assign FillPropertiesObject instance (using a properly typed node) to inputOutput SFNode field fillProperties.- Specified by:
setFillProperties
in interfaceAppearance
- Parameters:
newValue
- is new value for the fillProperties field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [FillProperties] Single contained FillProperties node that specifies additional visual attributes applied to polygonal areas of corresponding geometry, on top of whatever other appearance is already defined. *
-
clearFillProperties
Utility method to clear SFNode value of fillProperties field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setFillProperties
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fillProperties.- Parameters:
newValue
- is new value for the fillProperties field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setFillProperties(FillProperties)
-
hasFillProperties
public boolean hasFillProperties()Indicate whether an object is available for inputOutput SFNode field fillProperties.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getFillProperties()
,getFillPropertiesProtoInstance()
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
AppearanceObject
- 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
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasIS
public boolean hasIS()Indicate whether an object is available for inputOutput SFNode field IS.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
getIS()
-
getLineProperties
Provide LinePropertiesObject instance (using a properly typed node) from inputOutput SFNode field lineProperties.- Specified by:
getLineProperties
in interfaceAppearance
- Returns:
- value of lineProperties field
- See Also:
Tooltip: [LineProperties] Single contained LineProperties node that specifies additional visual attributes applied to corresponding line geometry. *
-
setLineProperties
Accessor method to assign LinePropertiesObject instance (using a properly typed node) to inputOutput SFNode field lineProperties.- Specified by:
setLineProperties
in interfaceAppearance
- Parameters:
newValue
- is new value for the lineProperties field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [LineProperties] Single contained LineProperties node that specifies additional visual attributes applied to corresponding line geometry. *
-
clearLineProperties
Utility method to clear SFNode value of lineProperties field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setLineProperties
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field lineProperties.- Parameters:
newValue
- is new value for the lineProperties field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setLineProperties(LineProperties)
-
hasLineProperties
public boolean hasLineProperties()Indicate whether an object is available for inputOutput SFNode field lineProperties.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getLineProperties()
,getLinePropertiesProtoInstance()
-
getMaterial
Provide X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.- Specified by:
getMaterial
in interfaceAppearance
- Returns:
- value of material field
- See Also:
Tooltip: [X3DMaterialNode] Single contained Material node that specifies visual attributes for lighting response (color types, transparency, etc.) applied to corresponding geometry. Warning: if material is NULL or unspecified, lighting is off (all lights ignored) for this Shape and unlit object color is (1, 1, 1).
-
setMaterial
Accessor method to assign X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.- Specified by:
setMaterial
in interfaceAppearance
- Parameters:
newValue
- is new value for the material field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DMaterialNode] Single contained Material node that specifies visual attributes for lighting response (color types, transparency, etc.) applied to corresponding geometry. Warning: if material is NULL or unspecified, lighting is off (all lights ignored) for this Shape and unlit object color is (1, 1, 1).
-
clearMaterial
Utility method to clear SFNode value of material field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMaterial
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field material.- Parameters:
newValue
- is new value for the material field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMaterial(X3DMaterialNode)
-
hasMaterial
public boolean hasMaterial()Indicate whether an object is available for inputOutput SFNode field material.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getMaterial()
,getMaterialProtoInstance()
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceAppearance
- Specified by:
getMetadata
in interfaceX3DAppearanceNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceAppearance
- Specified by:
setMetadata
in interfaceX3DAppearanceNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
AppearanceObject
- 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
-
getPointProperties
Provide PointPropertiesObject instance (using a properly typed node) from inputOutput SFNode field pointProperties.- Specified by:
getPointProperties
in interfaceAppearance
- Returns:
- value of pointProperties field
- See Also:
getPointPropertiesProtoInstance()
-
setPointProperties
Accessor method to assign PointPropertiesObject instance (using a properly typed node) to inputOutput SFNode field pointProperties.- Specified by:
setPointProperties
in interfaceAppearance
- Parameters:
newValue
- is new value for the pointProperties field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setPointProperties(ProtoInstanceObject)
-
clearPointProperties
Utility method to clear SFNode value of pointProperties field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setPointProperties
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field pointProperties.- Parameters:
newValue
- is new value for the pointProperties field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setPointProperties(PointProperties)
-
hasPointProperties
public boolean hasPointProperties()Indicate whether an object is available for inputOutput SFNode field pointProperties.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getPointProperties()
,getPointPropertiesProtoInstance()
-
getShaders
Provide array of X3DShaderNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field shaders.
Tooltip: [X3DShaderNode] Zero or more contained programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) that specify, in order of preference, author-programmed rendering characteristics.- Hint: X3D Architecture 31 Programmable shaders component https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shaders.html
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DShaderNode.- Specified by:
getShaders
in interfaceAppearance
- Returns:
- value of shaders field
- See Also:
X3DShaderNode
-
getShadersList
Utility method to get ArrayList value of MFNode shaders field, similar togetShaders()
.- Returns:
- value of shaders field
-
setShaders
Accessor method to assign X3DShaderNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field shaders.
Tooltip: [X3DShaderNode] Zero or more contained programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) that specify, in order of preference, author-programmed rendering characteristics.- Hint: X3D Architecture 31 Programmable shaders component https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shaders.html
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DShaderNode.- Specified by:
setShaders
in interfaceAppearance
- Parameters:
newValue
- is new value for the shaders field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setShaders
Assign ArrayList value of MFNode shaders field, similar tosetShaders(X3DNode[])
.- Parameters:
newValue
- is new value for the shaders field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addShaders
Add single child node to existing array of shaders nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DShaderNode and ProtoInstance.- Parameters:
newValue
- is new value to be appended the shaders field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addShaders
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for shaders field.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.- Parameters:
newValue
- is new value to be appended the parts field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addShaders
Add array of child shaders nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DShaderNode.- Specified by:
addShaders
in interfaceAppearance
- Parameters:
newValue
- is new value array to be appended the shaders field.
-
setShaders
Set single child shaders node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DShaderNode.- Specified by:
setShaders
in interfaceAppearance
- Parameters:
newValue
- is new node for the shaders field (restricted to X3DShaderNode)
-
clearShaders
Utility method to clear MFNode value of shaders field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasShaders
public boolean hasShaders()Indicate whether an object is available for inputOutput MFNode field shaders.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
getShaders()
-
getTexture
Provide X3DTextureNode instance (using a properly typed node) from inputOutput SFNode field texture.- Specified by:
getTexture
in interfaceAppearance
- Returns:
- value of texture field
- See Also:
Tooltip: [X3DTextureNode] Single contained texture node (ImageTexture, MovieTexture, PixelTexture, MultiTexture) that maps image(s) to surface geometry. Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured. Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images Hint: X3D Architecture 18 Texturing component https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texture3D.html
-
setTexture
Accessor method to assign X3DTextureNode instance (using a properly typed node) to inputOutput SFNode field texture.- Specified by:
setTexture
in interfaceAppearance
- Parameters:
newValue
- is new value for the texture field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DTextureNode] Single contained texture node (ImageTexture, MovieTexture, PixelTexture, MultiTexture) that maps image(s) to surface geometry. Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured. Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images Hint: X3D Architecture 18 Texturing component https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texture3D.html
-
clearTexture
Utility method to clear SFNode value of texture field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setTexture
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texture.- Parameters:
newValue
- is new value for the texture field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setTexture(X3DTextureNode)
-
hasTexture
public boolean hasTexture()Indicate whether an object is available for inputOutput SFNode field texture.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getTexture()
,getTextureProtoInstance()
-
getTextureTransform
Provide X3DTextureTransformNode instance (using a properly typed node) from inputOutput SFNode field textureTransform.- Specified by:
getTextureTransform
in interfaceAppearance
- Returns:
- value of textureTransform field
- See Also:
Tooltip: [X3DTextureTransformNode] Single contained TextureTransform node that defines 2D transformation applied to texture coordinates. Hint: if textureTransform array is empty, then this field has no effect.
-
setTextureTransform
Accessor method to assign X3DTextureTransformNode instance (using a properly typed node) to inputOutput SFNode field textureTransform.- Specified by:
setTextureTransform
in interfaceAppearance
- Parameters:
newValue
- is new value for the textureTransform field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DTextureTransformNode] Single contained TextureTransform node that defines 2D transformation applied to texture coordinates. Hint: if textureTransform array is empty, then this field has no effect.
-
clearTextureTransform
Utility method to clear SFNode value of textureTransform field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setTextureTransform
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field textureTransform.- Parameters:
newValue
- is new value for the textureTransform field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setTextureTransform(X3DTextureTransformNode)
-
hasTextureTransform
public boolean hasTextureTransform()Indicate whether an object is available for inputOutput SFNode field textureTransform.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getTextureTransform()
,getTextureTransformProtoInstance()
-
getDEF
public java.lang.String getDEF()Provide String value from 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
Accessor method to 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.String getUSE()Provide String value from 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.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
Accessor method to 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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from 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
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to 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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
AppearanceObject
- 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
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
AppearanceObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
AppearanceObject
- 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 classX3DConcreteElement
- 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, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- 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 classX3DConcreteElement
- 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
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 classX3DConcreteElement
- 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 classX3DConcreteElement
- 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
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 classX3DConcreteElement
- 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 classX3DConcreteElement
- Returns:
- validation results (if any)
-