Package org.web3d.x3d.jsail.Shape
Class TwoSidedMaterialObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Shape.TwoSidedMaterialObject
- All Implemented Interfaces:
X3DNode
,TwoSidedMaterial
,X3DAppearanceChildNode
,X3DMaterialNode
public class TwoSidedMaterialObject extends X3DConcreteNode implements TwoSidedMaterial
TwoSidedMaterial specifies surface rendering properties for associated geometry nodes, for outer (front) and inner (back) sides of polygons.
X3D node tooltip: (X3D version 3.2 or later) [X3DMaterialNode] TwoSidedMaterial specifies surface rendering properties for associated geometry nodes, for outer (front) and inner (back) sides of polygons. Material attributes are used by the X3D lighting equations during rendering.
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.
X3D node tooltip: (X3D version 3.2 or later) [X3DMaterialNode] TwoSidedMaterial specifies surface rendering properties for associated geometry nodes, for outer (front) and inner (back) sides of polygons. Material attributes are used by the X3D lighting equations during rendering.
- Warning: requires X3D profile='Full' or else include <component name='Shape' level='4'/>
- Hint: insert Shape and Appearance nodes before adding material.
- Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Warning: corresponding geometry within the parent Shape must have solid='false' for two-sided rendering, otherwise no reverse-side back geometry is displayed.
- Hint: X3D Architecture 12.2.3 Two-sided materials https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shape.html#TwoSidedMaterials
- Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/lighting.html#Lightingmodel
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.
-
Field Summary
Fields Modifier and Type Field Description static float
AMBIENTINTENSITY_DEFAULT_VALUE
SFFloat field named ambientIntensity has default value 0.2f (Java syntax) or 0.2 (XML syntax).static float
BACKAMBIENTINTENSITY_DEFAULT_VALUE
SFFloat field named backAmbientIntensity has default value 0.2f (Java syntax) or 0.2 (XML syntax).static float[]
BACKDIFFUSECOLOR_DEFAULT_VALUE
SFColor field named backDiffuseColor has default value {0.8f,0.8f,0.8f} (Java syntax) or 0.8 0.8 0.8 (XML syntax).static float[]
BACKEMISSIVECOLOR_DEFAULT_VALUE
SFColor field named backEmissiveColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static float
BACKSHININESS_DEFAULT_VALUE
SFFloat field named backShininess has default value 0.2f (Java syntax) or 0.2 (XML syntax).static float[]
BACKSPECULARCOLOR_DEFAULT_VALUE
SFColor field named backSpecularColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static float
BACKTRANSPARENCY_DEFAULT_VALUE
SFFloat field named backTransparency has default value 0f (Java syntax) or 0 (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the TwoSidedMaterial element: Shapestatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static float[]
DIFFUSECOLOR_DEFAULT_VALUE
SFColor field named diffuseColor has default value {0.8f,0.8f,0.8f} (Java syntax) or 0.8 0.8 0.8 (XML syntax).static float[]
EMISSIVECOLOR_DEFAULT_VALUE
SFColor field named emissiveColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static java.lang.String
fromField_AMBIENTINTENSITY
fromField ROUTE name for SFFloat field named ambientIntensity.static java.lang.String
fromField_BACKAMBIENTINTENSITY
fromField ROUTE name for SFFloat field named backAmbientIntensity.static java.lang.String
fromField_BACKDIFFUSECOLOR
fromField ROUTE name for SFColor field named backDiffuseColor.static java.lang.String
fromField_BACKEMISSIVECOLOR
fromField ROUTE name for SFColor field named backEmissiveColor.static java.lang.String
fromField_BACKSHININESS
fromField ROUTE name for SFFloat field named backShininess.static java.lang.String
fromField_BACKSPECULARCOLOR
fromField ROUTE name for SFColor field named backSpecularColor.static java.lang.String
fromField_BACKTRANSPARENCY
fromField ROUTE name for SFFloat field named backTransparency.static java.lang.String
fromField_DIFFUSECOLOR
fromField ROUTE name for SFColor field named diffuseColor.static java.lang.String
fromField_EMISSIVECOLOR
fromField ROUTE name for SFColor field named emissiveColor.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_SEPARATEBACKCOLOR
fromField ROUTE name for SFBool field named separateBackColor.static java.lang.String
fromField_SHININESS
fromField ROUTE name for SFFloat field named shininess.static java.lang.String
fromField_SPECULARCOLOR
fromField ROUTE name for SFColor field named specularColor.static java.lang.String
fromField_TRANSPARENCY
fromField ROUTE name for SFFloat field named transparency.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: 4static 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: TwoSidedMaterial.static boolean
SEPARATEBACKCOLOR_DEFAULT_VALUE
SFBool field named separateBackColor has default value false (Java syntax) or false (XML syntax).static float
SHININESS_DEFAULT_VALUE
SFFloat field named shininess has default value 0.2f (Java syntax) or 0.2 (XML syntax).static float[]
SPECULARCOLOR_DEFAULT_VALUE
SFColor field named specularColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static java.lang.String
toField_AMBIENTINTENSITY
toField ROUTE name for SFFloat field named ambientIntensity.static java.lang.String
toField_BACKAMBIENTINTENSITY
toField ROUTE name for SFFloat field named backAmbientIntensity.static java.lang.String
toField_BACKDIFFUSECOLOR
toField ROUTE name for SFColor field named backDiffuseColor.static java.lang.String
toField_BACKEMISSIVECOLOR
toField ROUTE name for SFColor field named backEmissiveColor.static java.lang.String
toField_BACKSHININESS
toField ROUTE name for SFFloat field named backShininess.static java.lang.String
toField_BACKSPECULARCOLOR
toField ROUTE name for SFColor field named backSpecularColor.static java.lang.String
toField_BACKTRANSPARENCY
toField ROUTE name for SFFloat field named backTransparency.static java.lang.String
toField_DIFFUSECOLOR
toField ROUTE name for SFColor field named diffuseColor.static java.lang.String
toField_EMISSIVECOLOR
toField ROUTE name for SFColor field named emissiveColor.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_SEPARATEBACKCOLOR
toField ROUTE name for SFBool field named separateBackColor.static java.lang.String
toField_SHININESS
toField ROUTE name for SFFloat field named shininess.static java.lang.String
toField_SPECULARCOLOR
toField ROUTE name for SFColor field named specularColor.static java.lang.String
toField_TRANSPARENCY
toField ROUTE name for SFFloat field named transparency.static float
TRANSPARENCY_DEFAULT_VALUE
SFFloat field named transparency 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
-
Constructor Summary
Constructors Constructor Description TwoSidedMaterialObject()
Constructor for TwoSidedMaterialObject to initialize member variables with default values.TwoSidedMaterialObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description TwoSidedMaterialObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.TwoSidedMaterialObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.TwoSidedMaterialObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.TwoSidedMaterialObject
clearIS()
Utility method to clear SFNode value of IS field.TwoSidedMaterialObject
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.float
getAmbientIntensity()
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named ambientIntensity.float
getBackAmbientIntensity()
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named backAmbientIntensity.float[]
getBackDiffuseColor()
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named backDiffuseColor.float[]
getBackEmissiveColor()
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named backEmissiveColor.float
getBackShininess()
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named backShininess.float[]
getBackSpecularColor()
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named backSpecularColor.float
getBackTransparency()
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named backTransparency.java.lang.String
getComponent()
Defines X3D component for the TwoSidedMaterial element: Shapeint
getComponentLevel()
Provides default X3D component level for this element: 4java.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.float[]
getDiffuseColor()
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named diffuseColor.java.lang.String
getElementName()
Provides name of this element: TwoSidedMaterialfloat[]
getEmissiveColor()
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named emissiveColor.java.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.boolean
getSeparateBackColor()
Provide boolean value from inputOutput SFBool field named separateBackColor.float
getShininess()
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named shininess.float[]
getSpecularColor()
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named specularColor.float
getTransparency()
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.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
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.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.TwoSidedMaterialObject
setAmbientIntensity(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetAmbientIntensity(float)
.TwoSidedMaterialObject
setAmbientIntensity(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.TwoSidedMaterialObject
setAmbientIntensity(SFFloatObject newValue)
Assign typed object value to SFFloat ambientIntensity field, similar tosetAmbientIntensity(float)
.TwoSidedMaterialObject
setBackAmbientIntensity(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetBackAmbientIntensity(float)
.TwoSidedMaterialObject
setBackAmbientIntensity(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named backAmbientIntensity.TwoSidedMaterialObject
setBackAmbientIntensity(SFFloatObject newValue)
Assign typed object value to SFFloat backAmbientIntensity field, similar tosetBackAmbientIntensity(float)
.TwoSidedMaterialObject
setBackDiffuseColor(double[] newArray)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackDiffuseColor(float[])
.TwoSidedMaterialObject
setBackDiffuseColor(double red, double green, double blue)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackDiffuseColor(float[])
.TwoSidedMaterialObject
setBackDiffuseColor(float[] newValue)
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named backDiffuseColor.TwoSidedMaterialObject
setBackDiffuseColor(float red, float green, float blue)
Assign values to SFColor backDiffuseColor field, similar tosetBackDiffuseColor(float[])
.TwoSidedMaterialObject
setBackDiffuseColor(SFColorObject newValue)
Assign typed object value to SFColor backDiffuseColor field, similar tosetBackDiffuseColor(float[])
.TwoSidedMaterialObject
setBackEmissiveColor(double[] newArray)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackEmissiveColor(float[])
.TwoSidedMaterialObject
setBackEmissiveColor(double red, double green, double blue)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackEmissiveColor(float[])
.TwoSidedMaterialObject
setBackEmissiveColor(float[] newValue)
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named backEmissiveColor.TwoSidedMaterialObject
setBackEmissiveColor(float red, float green, float blue)
Assign values to SFColor backEmissiveColor field, similar tosetBackEmissiveColor(float[])
.TwoSidedMaterialObject
setBackEmissiveColor(SFColorObject newValue)
Assign typed object value to SFColor backEmissiveColor field, similar tosetBackEmissiveColor(float[])
.TwoSidedMaterialObject
setBackShininess(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetBackShininess(float)
.TwoSidedMaterialObject
setBackShininess(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named backShininess.TwoSidedMaterialObject
setBackShininess(SFFloatObject newValue)
Assign typed object value to SFFloat backShininess field, similar tosetBackShininess(float)
.TwoSidedMaterialObject
setBackSpecularColor(double[] newArray)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackSpecularColor(float[])
.TwoSidedMaterialObject
setBackSpecularColor(double red, double green, double blue)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackSpecularColor(float[])
.TwoSidedMaterialObject
setBackSpecularColor(float[] newValue)
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named backSpecularColor.TwoSidedMaterialObject
setBackSpecularColor(float red, float green, float blue)
Assign values to SFColor backSpecularColor field, similar tosetBackSpecularColor(float[])
.TwoSidedMaterialObject
setBackSpecularColor(SFColorObject newValue)
Assign typed object value to SFColor backSpecularColor field, similar tosetBackSpecularColor(float[])
.TwoSidedMaterialObject
setBackTransparency(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetBackTransparency(float)
.TwoSidedMaterialObject
setBackTransparency(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named backTransparency.TwoSidedMaterialObject
setBackTransparency(SFFloatObject newValue)
Assign typed object value to SFFloat backTransparency field, similar tosetBackTransparency(float)
.TwoSidedMaterialObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.TwoSidedMaterialObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.TwoSidedMaterialObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.TwoSidedMaterialObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.TwoSidedMaterialObject
setDiffuseColor(double[] newArray)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetDiffuseColor(float[])
.TwoSidedMaterialObject
setDiffuseColor(double red, double green, double blue)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetDiffuseColor(float[])
.TwoSidedMaterialObject
setDiffuseColor(float[] newValue)
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named diffuseColor.TwoSidedMaterialObject
setDiffuseColor(float red, float green, float blue)
Assign values to SFColor diffuseColor field, similar tosetDiffuseColor(float[])
.TwoSidedMaterialObject
setDiffuseColor(SFColorObject newValue)
Assign typed object value to SFColor diffuseColor field, similar tosetDiffuseColor(float[])
.TwoSidedMaterialObject
setEmissiveColor(double[] newArray)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetEmissiveColor(float[])
.TwoSidedMaterialObject
setEmissiveColor(double red, double green, double blue)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetEmissiveColor(float[])
.TwoSidedMaterialObject
setEmissiveColor(float[] newValue)
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named emissiveColor.TwoSidedMaterialObject
setEmissiveColor(float red, float green, float blue)
Assign values to SFColor emissiveColor field, similar tosetEmissiveColor(float[])
.TwoSidedMaterialObject
setEmissiveColor(SFColorObject newValue)
Assign typed object value to SFColor emissiveColor field, similar tosetEmissiveColor(float[])
.TwoSidedMaterialObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.TwoSidedMaterialObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.TwoSidedMaterialObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.TwoSidedMaterialObject
setSeparateBackColor(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named separateBackColor.TwoSidedMaterialObject
setSeparateBackColor(SFBoolObject newValue)
Assign typed object value to SFBool separateBackColor field, similar tosetSeparateBackColor(boolean)
.TwoSidedMaterialObject
setShininess(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetShininess(float)
.TwoSidedMaterialObject
setShininess(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named shininess.TwoSidedMaterialObject
setShininess(SFFloatObject newValue)
Assign typed object value to SFFloat shininess field, similar tosetShininess(float)
.TwoSidedMaterialObject
setSpecularColor(double[] newArray)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetSpecularColor(float[])
.TwoSidedMaterialObject
setSpecularColor(double red, double green, double blue)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetSpecularColor(float[])
.TwoSidedMaterialObject
setSpecularColor(float[] newValue)
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named specularColor.TwoSidedMaterialObject
setSpecularColor(float red, float green, float blue)
Assign values to SFColor specularColor field, similar tosetSpecularColor(float[])
.TwoSidedMaterialObject
setSpecularColor(SFColorObject newValue)
Assign typed object value to SFColor specularColor field, similar tosetSpecularColor(float[])
.TwoSidedMaterialObject
setTransparency(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetTransparency(float)
.TwoSidedMaterialObject
setTransparency(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named transparency.TwoSidedMaterialObject
setTransparency(SFFloatObject newValue)
Assign typed object value to SFFloat transparency field, similar tosetTransparency(float)
.TwoSidedMaterialObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.TwoSidedMaterialObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.TwoSidedMaterialObject
setUSE(TwoSidedMaterialObject 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: TwoSidedMaterial.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the TwoSidedMaterial element: Shape- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Shape component level for this element: 4- See Also:
- Constant Field Values
-
AMBIENTINTENSITY_DEFAULT_VALUE
public static final float AMBIENTINTENSITY_DEFAULT_VALUESFFloat field named ambientIntensity has default value 0.2f (Java syntax) or 0.2 (XML syntax).- See Also:
- Constant Field Values
-
BACKAMBIENTINTENSITY_DEFAULT_VALUE
public static final float BACKAMBIENTINTENSITY_DEFAULT_VALUESFFloat field named backAmbientIntensity has default value 0.2f (Java syntax) or 0.2 (XML syntax).- See Also:
- Constant Field Values
-
BACKDIFFUSECOLOR_DEFAULT_VALUE
public static final float[] BACKDIFFUSECOLOR_DEFAULT_VALUESFColor field named backDiffuseColor has default value {0.8f,0.8f,0.8f} (Java syntax) or 0.8 0.8 0.8 (XML syntax). -
BACKEMISSIVECOLOR_DEFAULT_VALUE
public static final float[] BACKEMISSIVECOLOR_DEFAULT_VALUESFColor field named backEmissiveColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
BACKSHININESS_DEFAULT_VALUE
public static final float BACKSHININESS_DEFAULT_VALUESFFloat field named backShininess has default value 0.2f (Java syntax) or 0.2 (XML syntax).- See Also:
- Constant Field Values
-
BACKSPECULARCOLOR_DEFAULT_VALUE
public static final float[] BACKSPECULARCOLOR_DEFAULT_VALUESFColor field named backSpecularColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
BACKTRANSPARENCY_DEFAULT_VALUE
public static final float BACKTRANSPARENCY_DEFAULT_VALUESFFloat field named backTransparency has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
DIFFUSECOLOR_DEFAULT_VALUE
public static final float[] DIFFUSECOLOR_DEFAULT_VALUESFColor field named diffuseColor has default value {0.8f,0.8f,0.8f} (Java syntax) or 0.8 0.8 0.8 (XML syntax). -
EMISSIVECOLOR_DEFAULT_VALUE
public static final float[] EMISSIVECOLOR_DEFAULT_VALUESFColor field named emissiveColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS 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). -
SEPARATEBACKCOLOR_DEFAULT_VALUE
public static final boolean SEPARATEBACKCOLOR_DEFAULT_VALUESFBool field named separateBackColor has default value false (Java syntax) or false (XML syntax).- See Also:
- Constant Field Values
-
SHININESS_DEFAULT_VALUE
public static final float SHININESS_DEFAULT_VALUESFFloat field named shininess has default value 0.2f (Java syntax) or 0.2 (XML syntax).- See Also:
- Constant Field Values
-
SPECULARCOLOR_DEFAULT_VALUE
public static final float[] SPECULARCOLOR_DEFAULT_VALUESFColor field named specularColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
TRANSPARENCY_DEFAULT_VALUE
public static final float TRANSPARENCY_DEFAULT_VALUESFFloat field named transparency 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_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_AMBIENTINTENSITY
public static final java.lang.String fromField_AMBIENTINTENSITYfromField ROUTE name for SFFloat field named ambientIntensity.- See Also:
- Constant Field Values
-
toField_AMBIENTINTENSITY
public static final java.lang.String toField_AMBIENTINTENSITYtoField ROUTE name for SFFloat field named ambientIntensity.- See Also:
- Constant Field Values
-
fromField_BACKAMBIENTINTENSITY
public static final java.lang.String fromField_BACKAMBIENTINTENSITYfromField ROUTE name for SFFloat field named backAmbientIntensity.- See Also:
- Constant Field Values
-
toField_BACKAMBIENTINTENSITY
public static final java.lang.String toField_BACKAMBIENTINTENSITYtoField ROUTE name for SFFloat field named backAmbientIntensity.- See Also:
- Constant Field Values
-
fromField_BACKDIFFUSECOLOR
public static final java.lang.String fromField_BACKDIFFUSECOLORfromField ROUTE name for SFColor field named backDiffuseColor.- See Also:
- Constant Field Values
-
toField_BACKDIFFUSECOLOR
public static final java.lang.String toField_BACKDIFFUSECOLORtoField ROUTE name for SFColor field named backDiffuseColor.- See Also:
- Constant Field Values
-
fromField_BACKEMISSIVECOLOR
public static final java.lang.String fromField_BACKEMISSIVECOLORfromField ROUTE name for SFColor field named backEmissiveColor.- See Also:
- Constant Field Values
-
toField_BACKEMISSIVECOLOR
public static final java.lang.String toField_BACKEMISSIVECOLORtoField ROUTE name for SFColor field named backEmissiveColor.- See Also:
- Constant Field Values
-
fromField_BACKSHININESS
public static final java.lang.String fromField_BACKSHININESSfromField ROUTE name for SFFloat field named backShininess.- See Also:
- Constant Field Values
-
toField_BACKSHININESS
public static final java.lang.String toField_BACKSHININESStoField ROUTE name for SFFloat field named backShininess.- See Also:
- Constant Field Values
-
fromField_BACKSPECULARCOLOR
public static final java.lang.String fromField_BACKSPECULARCOLORfromField ROUTE name for SFColor field named backSpecularColor.- See Also:
- Constant Field Values
-
toField_BACKSPECULARCOLOR
public static final java.lang.String toField_BACKSPECULARCOLORtoField ROUTE name for SFColor field named backSpecularColor.- See Also:
- Constant Field Values
-
fromField_BACKTRANSPARENCY
public static final java.lang.String fromField_BACKTRANSPARENCYfromField ROUTE name for SFFloat field named backTransparency.- See Also:
- Constant Field Values
-
toField_BACKTRANSPARENCY
public static final java.lang.String toField_BACKTRANSPARENCYtoField ROUTE name for SFFloat field named backTransparency.- See Also:
- Constant Field Values
-
fromField_DIFFUSECOLOR
public static final java.lang.String fromField_DIFFUSECOLORfromField ROUTE name for SFColor field named diffuseColor.- See Also:
- Constant Field Values
-
toField_DIFFUSECOLOR
public static final java.lang.String toField_DIFFUSECOLORtoField ROUTE name for SFColor field named diffuseColor.- See Also:
- Constant Field Values
-
fromField_EMISSIVECOLOR
public static final java.lang.String fromField_EMISSIVECOLORfromField ROUTE name for SFColor field named emissiveColor.- See Also:
- Constant Field Values
-
toField_EMISSIVECOLOR
public static final java.lang.String toField_EMISSIVECOLORtoField ROUTE name for SFColor field named emissiveColor.- 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_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_SEPARATEBACKCOLOR
public static final java.lang.String fromField_SEPARATEBACKCOLORfromField ROUTE name for SFBool field named separateBackColor.- See Also:
- Constant Field Values
-
toField_SEPARATEBACKCOLOR
public static final java.lang.String toField_SEPARATEBACKCOLORtoField ROUTE name for SFBool field named separateBackColor.- See Also:
- Constant Field Values
-
fromField_SHININESS
public static final java.lang.String fromField_SHININESSfromField ROUTE name for SFFloat field named shininess.- See Also:
- Constant Field Values
-
toField_SHININESS
public static final java.lang.String toField_SHININESStoField ROUTE name for SFFloat field named shininess.- See Also:
- Constant Field Values
-
fromField_SPECULARCOLOR
public static final java.lang.String fromField_SPECULARCOLORfromField ROUTE name for SFColor field named specularColor.- See Also:
- Constant Field Values
-
toField_SPECULARCOLOR
public static final java.lang.String toField_SPECULARCOLORtoField ROUTE name for SFColor field named specularColor.- See Also:
- Constant Field Values
-
fromField_TRANSPARENCY
public static final java.lang.String fromField_TRANSPARENCYfromField ROUTE name for SFFloat field named transparency.- See Also:
- Constant Field Values
-
toField_TRANSPARENCY
public static final java.lang.String toField_TRANSPARENCYtoField ROUTE name for SFFloat field named transparency.- See Also:
- Constant Field Values
-
-
Constructor Details
-
TwoSidedMaterialObject
public TwoSidedMaterialObject()Constructor for TwoSidedMaterialObject to initialize member variables with default values. -
TwoSidedMaterialObject
public TwoSidedMaterialObject(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: TwoSidedMaterial- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the TwoSidedMaterial 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: 4- 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
-
getAmbientIntensity
public float getAmbientIntensity()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named ambientIntensity.
Tooltip: [0,1] how much ambient omnidirectional light is reflected from all light sources. Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
getAmbientIntensity
in interfaceTwoSidedMaterial
- Returns:
- value of ambientIntensity field
-
setAmbientIntensity
Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.
Tooltip: [0,1] how much ambient omnidirectional light is reflected from all light sources. Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
setAmbientIntensity
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the ambientIntensity field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAmbientIntensity
Assign typed object value to SFFloat ambientIntensity field, similar tosetAmbientIntensity(float)
.- Parameters:
newValue
- is new value for the ambientIntensity field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAmbientIntensity
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetAmbientIntensity(float)
.- Parameters:
newValue
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBackAmbientIntensity
public float getBackAmbientIntensity()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named backAmbientIntensity.
Tooltip: [0,1] how much ambient omnidirectional light is reflected from all light sources. Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
getBackAmbientIntensity
in interfaceTwoSidedMaterial
- Returns:
- value of backAmbientIntensity field
-
setBackAmbientIntensity
Accessor method to assign float value to inputOutput SFFloat field named backAmbientIntensity.
Tooltip: [0,1] how much ambient omnidirectional light is reflected from all light sources. Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
setBackAmbientIntensity
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the backAmbientIntensity field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackAmbientIntensity
Assign typed object value to SFFloat backAmbientIntensity field, similar tosetBackAmbientIntensity(float)
.- Parameters:
newValue
- is new value for the backAmbientIntensity field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackAmbientIntensity
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetBackAmbientIntensity(float)
.- Parameters:
newValue
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBackDiffuseColor
public float[] getBackDiffuseColor()Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named backDiffuseColor.
Tooltip: [0,1] how much direct, angle-dependent light is reflected from all light sources.- Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
- Specified by:
getBackDiffuseColor
in interfaceTwoSidedMaterial
- Returns:
- value of backDiffuseColor field
-
setBackDiffuseColor
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named backDiffuseColor.
Tooltip: [0,1] how much direct, angle-dependent light is reflected from all light sources.- Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
- Specified by:
setBackDiffuseColor
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the backDiffuseColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackDiffuseColor
Assign typed object value to SFColor backDiffuseColor field, similar tosetBackDiffuseColor(float[])
.- Parameters:
newValue
- is new value for the backDiffuseColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackDiffuseColor
Assign values to SFColor backDiffuseColor field, similar tosetBackDiffuseColor(float[])
.- Parameters:
red
- first componentgreen
- second componentblue
- third component- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackDiffuseColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackDiffuseColor(float[])
.- Parameters:
red
- first component [0..1]green
- second component [0..1]blue
- third component [0..1]- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackDiffuseColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackDiffuseColor(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBackEmissiveColor
public float[] getBackEmissiveColor()Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named backEmissiveColor.
Tooltip: [0,1] how much glowing light is emitted from this object.- Hint: emissiveColors glow even when all lights are off.
- Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
- Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
- Warning: bright emissiveColor values can wash out other colors and some textures.
- Specified by:
getBackEmissiveColor
in interfaceTwoSidedMaterial
- Returns:
- value of backEmissiveColor field
-
setBackEmissiveColor
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named backEmissiveColor.
Tooltip: [0,1] how much glowing light is emitted from this object.- Hint: emissiveColors glow even when all lights are off.
- Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
- Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
- Warning: bright emissiveColor values can wash out other colors and some textures.
- Specified by:
setBackEmissiveColor
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the backEmissiveColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackEmissiveColor
Assign typed object value to SFColor backEmissiveColor field, similar tosetBackEmissiveColor(float[])
.- Parameters:
newValue
- is new value for the backEmissiveColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackEmissiveColor
Assign values to SFColor backEmissiveColor field, similar tosetBackEmissiveColor(float[])
.- Parameters:
red
- first componentgreen
- second componentblue
- third component- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackEmissiveColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackEmissiveColor(float[])
.- Parameters:
red
- first component [0..1]green
- second component [0..1]blue
- third component [0..1]- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackEmissiveColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackEmissiveColor(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBackShininess
public float getBackShininess()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named backShininess.
Tooltip: [0,1] Lower shininess values provide soft specular glows, while higher values result in sharper, smaller highlights. Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
getBackShininess
in interfaceTwoSidedMaterial
- Returns:
- value of backShininess field
-
setBackShininess
Accessor method to assign float value to inputOutput SFFloat field named backShininess.
Tooltip: [0,1] Lower shininess values provide soft specular glows, while higher values result in sharper, smaller highlights. Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
setBackShininess
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the backShininess field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackShininess
Assign typed object value to SFFloat backShininess field, similar tosetBackShininess(float)
.- Parameters:
newValue
- is new value for the backShininess field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackShininess
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetBackShininess(float)
.- Parameters:
newValue
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBackSpecularColor
public float[] getBackSpecularColor()Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named backSpecularColor.
Tooltip: [0,1] specular highlights are brightness reflections (example: shiny spots on an apple). Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
getBackSpecularColor
in interfaceTwoSidedMaterial
- Returns:
- value of backSpecularColor field
-
setBackSpecularColor
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named backSpecularColor.
Tooltip: [0,1] specular highlights are brightness reflections (example: shiny spots on an apple). Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
setBackSpecularColor
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the backSpecularColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackSpecularColor
Assign typed object value to SFColor backSpecularColor field, similar tosetBackSpecularColor(float[])
.- Parameters:
newValue
- is new value for the backSpecularColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackSpecularColor
Assign values to SFColor backSpecularColor field, similar tosetBackSpecularColor(float[])
.- Parameters:
red
- first componentgreen
- second componentblue
- third component- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackSpecularColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackSpecularColor(float[])
.- Parameters:
red
- first component [0..1]green
- second component [0..1]blue
- third component [0..1]- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackSpecularColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBackSpecularColor(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBackTransparency
public float getBackTransparency()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named backTransparency.
Tooltip: [0,1] how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile hint: transparency < .5 opaque, transparency > .5 transparent. *- Specified by:
getBackTransparency
in interfaceTwoSidedMaterial
- Returns:
- value of backTransparency field
-
setBackTransparency
Accessor method to assign float value to inputOutput SFFloat field named backTransparency.
Tooltip: [0,1] how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile hint: transparency < .5 opaque, transparency > .5 transparent. *- Specified by:
setBackTransparency
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the backTransparency field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackTransparency
Assign typed object value to SFFloat backTransparency field, similar tosetBackTransparency(float)
.- Parameters:
newValue
- is new value for the backTransparency field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBackTransparency
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetBackTransparency(float)
.- Parameters:
newValue
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDiffuseColor
public float[] getDiffuseColor()Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named diffuseColor.
Tooltip: [0,1] how much direct, angle-dependent light is reflected from all light sources.- Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
- Specified by:
getDiffuseColor
in interfaceTwoSidedMaterial
- Returns:
- value of diffuseColor field
-
setDiffuseColor
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named diffuseColor.
Tooltip: [0,1] how much direct, angle-dependent light is reflected from all light sources.- Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
- Specified by:
setDiffuseColor
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the diffuseColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDiffuseColor
Assign typed object value to SFColor diffuseColor field, similar tosetDiffuseColor(float[])
.- Parameters:
newValue
- is new value for the diffuseColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDiffuseColor
Assign values to SFColor diffuseColor field, similar tosetDiffuseColor(float[])
.- Parameters:
red
- first componentgreen
- second componentblue
- third component- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDiffuseColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetDiffuseColor(float[])
.- Parameters:
red
- first component [0..1]green
- second component [0..1]blue
- third component [0..1]- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDiffuseColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetDiffuseColor(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getEmissiveColor
public float[] getEmissiveColor()Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named emissiveColor.
Tooltip: [0,1] how much glowing light is emitted from this object.- Hint: emissiveColors glow even when all lights are off.
- Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
- Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
- Warning: bright emissiveColor values can wash out other colors and some textures.
- Specified by:
getEmissiveColor
in interfaceTwoSidedMaterial
- Returns:
- value of emissiveColor field
-
setEmissiveColor
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named emissiveColor.
Tooltip: [0,1] how much glowing light is emitted from this object.- Hint: emissiveColors glow even when all lights are off.
- Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
- Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
- Warning: bright emissiveColor values can wash out other colors and some textures.
- Specified by:
setEmissiveColor
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the emissiveColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEmissiveColor
Assign typed object value to SFColor emissiveColor field, similar tosetEmissiveColor(float[])
.- Parameters:
newValue
- is new value for the emissiveColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEmissiveColor
Assign values to SFColor emissiveColor field, similar tosetEmissiveColor(float[])
.- Parameters:
red
- first componentgreen
- second componentblue
- third component- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEmissiveColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetEmissiveColor(float[])
.- Parameters:
red
- first component [0..1]green
- second component [0..1]blue
- third component [0..1]- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEmissiveColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetEmissiveColor(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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()
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceTwoSidedMaterial
- Specified by:
getMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
getMetadata
in interfaceX3DMaterialNode
- 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 interfaceTwoSidedMaterial
- Specified by:
setMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
setMetadata
in interfaceX3DMaterialNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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
-
getSeparateBackColor
public boolean getSeparateBackColor()Provide boolean value from inputOutput SFBool field named separateBackColor.
Tooltip: separateBackColor determines whether separate Material values are used for back faces.- Warning: backface Material values are ignored unless you set separateBackColor='true'.
- Specified by:
getSeparateBackColor
in interfaceTwoSidedMaterial
- Returns:
- value of separateBackColor field
-
setSeparateBackColor
Accessor method to assign boolean value to inputOutput SFBool field named separateBackColor.
Tooltip: separateBackColor determines whether separate Material values are used for back faces.- Warning: backface Material values are ignored unless you set separateBackColor='true'.
- Specified by:
setSeparateBackColor
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the separateBackColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSeparateBackColor
Assign typed object value to SFBool separateBackColor field, similar tosetSeparateBackColor(boolean)
.- Parameters:
newValue
- is new value for the separateBackColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getShininess
public float getShininess()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named shininess.
Tooltip: [0,1] Lower shininess values provide soft specular glows, while higher values result in sharper, smaller highlights. Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
getShininess
in interfaceTwoSidedMaterial
- Returns:
- value of shininess field
-
setShininess
Accessor method to assign float value to inputOutput SFFloat field named shininess.
Tooltip: [0,1] Lower shininess values provide soft specular glows, while higher values result in sharper, smaller highlights. Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
setShininess
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the shininess field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setShininess
Assign typed object value to SFFloat shininess field, similar tosetShininess(float)
.- Parameters:
newValue
- is new value for the shininess field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setShininess
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetShininess(float)
.- Parameters:
newValue
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSpecularColor
public float[] getSpecularColor()Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named specularColor.
Tooltip: [0,1] specular highlights are brightness reflections (example: shiny spots on an apple). Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
getSpecularColor
in interfaceTwoSidedMaterial
- Returns:
- value of specularColor field
-
setSpecularColor
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named specularColor.
Tooltip: [0,1] specular highlights are brightness reflections (example: shiny spots on an apple). Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
setSpecularColor
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the specularColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSpecularColor
Assign typed object value to SFColor specularColor field, similar tosetSpecularColor(float[])
.- Parameters:
newValue
- is new value for the specularColor field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSpecularColor
Assign values to SFColor specularColor field, similar tosetSpecularColor(float[])
.- Parameters:
red
- first componentgreen
- second componentblue
- third component- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSpecularColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetSpecularColor(float[])
.- Parameters:
red
- first component [0..1]green
- second component [0..1]blue
- third component [0..1]- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSpecularColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetSpecularColor(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTransparency
public float getTransparency()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.
Tooltip: [0,1] how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile hint: transparency < .5 opaque, transparency > .5 transparent. *- Specified by:
getTransparency
in interfaceTwoSidedMaterial
- Returns:
- value of transparency field
-
setTransparency
Accessor method to assign float value to inputOutput SFFloat field named transparency.
Tooltip: [0,1] how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile hint: transparency < .5 opaque, transparency > .5 transparent. *- Specified by:
setTransparency
in interfaceTwoSidedMaterial
- Parameters:
newValue
- is new value for the transparency field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTransparency
Assign typed object value to SFFloat transparency field, similar tosetTransparency(float)
.- Parameters:
newValue
- is new value for the transparency field.- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTransparency
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetTransparency(float)
.- Parameters:
newValue
- is new value for field- Returns:
TwoSidedMaterialObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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:
TwoSidedMaterialObject
- 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)
-