Package org.web3d.x3d.jsail.Texturing
Class MultiTextureObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Texturing.MultiTextureObject
- All Implemented Interfaces:
X3DNode
,X3DAppearanceChildNode
,MultiTexture
,X3DTextureNode
public class MultiTextureObject extends X3DConcreteNode implements MultiTexture
MultiTexture applies several individual textures to a single geometry node, enabling a variety of visual effects that include light mapping and environment mapping.
X3D node tooltip: [X3DTextureNode] MultiTexture applies several individual textures to a single geometry node, enabling a variety of visual effects that include light mapping and environment mapping. MultiTexture can contain zero or more ImageTexture, MovieTexture and PixelTexture nodes. Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s, t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.
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: [X3DTextureNode] MultiTexture applies several individual textures to a single geometry node, enabling a variety of visual effects that include light mapping and environment mapping. MultiTexture can contain zero or more ImageTexture, MovieTexture and PixelTexture nodes. Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s, t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.
- Hint: insert Shape and Appearance nodes before adding texture.
- Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
- Warning: the number of textures to be blended may have a significant impact on performance, depending on available graphics hardware capabilities.
- Hint: multitexturing is accomplished using MultiTexture, MultiTextureCoordinate and MultiTextureTransform nodes.
- Hint: X3D Texturing component Figure 18.2 Lightmap example, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#f-Lightmapexample
- Hint: X3D Texturing component Table 18.2: Comparison of single texture and multitexture attributes, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-SingleAndMultitextureAttrs
- Hint: MultiTexture does not need to be included in LoadSensor watchList since any child ImageTexture and MovieTexture nodes of interest can be handled separately.
- Warning: MultiTexture may not contain another MultiTexture node.
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
ALPHA_DEFAULT_VALUE
SFFloat field named alpha has default value 1f (Java syntax) or 1 (XML syntax).static float[]
COLOR_DEFAULT_VALUE
SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the MultiTexture element: Texturingstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static java.lang.String
fromField_ALPHA
fromField ROUTE name for SFFloat field named alpha.static java.lang.String
fromField_COLOR
fromField ROUTE name for SFColor field named color.static java.lang.String
fromField_FUNCTION
fromField ROUTE name for MFString field named function.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_MODE
fromField ROUTE name for MFString field named mode.static java.lang.String
fromField_SOURCE
fromField ROUTE name for MFString field named source.static java.lang.String
fromField_TEXTURE
fromField ROUTE name for MFNode field named texture.static java.lang.String
FUNCTION_
Tooltip: No function is applied - empty SFString is allowed value within MFString array.static java.lang.String
FUNCTION_ALPHAREPLICATE
Tooltip: Replicate alpha information to all color channels before operation completes.static java.lang.String
FUNCTION_COMPLEMENT
Tooltip: Invert argument x as (1 - x).static java.util.ArrayList<java.lang.String>
FUNCTION_DEFAULT_VALUE
MFString field named function has default value equal to an empty list.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 Texturing component level for this element: 2static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
MODE_ADD
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADD" (Java syntax) or '"ADD"' (XML syntax).static java.lang.String
MODE_ADDSIGNED
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADDSIGNED" (Java syntax) or '"ADDSIGNED"' (XML syntax).static java.lang.String
MODE_ADDSIGNED2X
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADDSIGNED2X" (Java syntax) or '"ADDSIGNED2X"' (XML syntax).static java.lang.String
MODE_ADDSMOOTH
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADDSMOOTH" (Java syntax) or '"ADDSMOOTH"' (XML syntax).static java.lang.String
MODE_BLENDCURRENTALPHA
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDCURRENTALPHA" (Java syntax) or '"BLENDCURRENTALPHA"' (XML syntax).static java.lang.String
MODE_BLENDDIFFUSEALPHA
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDDIFFUSEALPHA" (Java syntax) or '"BLENDDIFFUSEALPHA"' (XML syntax).static java.lang.String
MODE_BLENDFACTORALPHA
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDFACTORALPHA" (Java syntax) or '"BLENDFACTORALPHA"' (XML syntax).static java.lang.String
MODE_BLENDTEXTUREALPHA
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDTEXTUREALPHA" (Java syntax) or '"BLENDTEXTUREALPHA"' (XML syntax).static java.util.ArrayList<java.lang.String>
MODE_DEFAULT_VALUE
MFString field named mode has default value equal to an empty list.static java.lang.String
MODE_DOTPRODUCT3
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "DOTPRODUCT3" (Java syntax) or '"DOTPRODUCT3"' (XML syntax).static java.lang.String
MODE_MODULATE
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATE" (Java syntax) or '"MODULATE"' (XML syntax).static java.lang.String
MODE_MODULATE2X
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATE2X" (Java syntax) or '"MODULATE2X"' (XML syntax).static java.lang.String
MODE_MODULATE4X
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATE4X" (Java syntax) or '"MODULATE4X"' (XML syntax).static java.lang.String
MODE_MODULATEALPHA_ADDCOLOR
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATEALPHA_ADDCOLOR" (Java syntax) or '"MODULATEALPHA_ADDCOLOR"' (XML syntax).static java.lang.String
MODE_MODULATEINVALPHA_ADDCOLOR
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATEINVALPHA_ADDCOLOR" (Java syntax) or '"MODULATEINVALPHA_ADDCOLOR"' (XML syntax).static java.lang.String
MODE_MODULATEINVCOLOR_ADDALPHA
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATEINVCOLOR_ADDALPHA" (Java syntax) or '"MODULATEINVCOLOR_ADDALPHA"' (XML syntax).static java.lang.String
MODE_OFF
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "OFF" (Java syntax) or '"OFF"' (XML syntax).static java.lang.String
MODE_REPLACE
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "REPLACE" (Java syntax) or '"REPLACE"' (XML syntax).static java.lang.String
MODE_SELECTARG1
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SELECTARG1" (Java syntax) or '"SELECTARG1"' (XML syntax).static java.lang.String
MODE_SELECTARG2
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SELECTARG2" (Java syntax) or '"SELECTARG2"' (XML syntax).static java.lang.String
MODE_SUBTRACT
MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SUBTRACT" (Java syntax) or '"SUBTRACT"' (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: MultiTexture.static java.lang.String
SOURCE_
MFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "" (Java syntax) or '""' (XML syntax).static java.util.ArrayList<java.lang.String>
SOURCE_DEFAULT_VALUE
MFString field named source has default value equal to an empty list.static java.lang.String
SOURCE_DIFFUSE
MFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "DIFFUSE" (Java syntax) or '"DIFFUSE"' (XML syntax).static java.lang.String
SOURCE_FACTOR
MFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "FACTOR" (Java syntax) or '"FACTOR"' (XML syntax).static java.lang.String
SOURCE_SPECULAR
MFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SPECULAR" (Java syntax) or '"SPECULAR"' (XML syntax).static java.lang.String
toField_ALPHA
toField ROUTE name for SFFloat field named alpha.static java.lang.String
toField_COLOR
toField ROUTE name for SFColor field named color.static java.lang.String
toField_FUNCTION
toField ROUTE name for MFString field named function.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_MODE
toField ROUTE name for MFString field named mode.static java.lang.String
toField_SOURCE
toField ROUTE name for MFString field named source.static java.lang.String
toField_TEXTURE
toField ROUTE name for MFNode field named texture.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 MultiTextureObject()
Constructor for MultiTextureObject to initialize member variables with default values.MultiTextureObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description MultiTextureObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.MultiTextureObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.MultiTextureObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.MultiTextureObject
addFunction(java.lang.String newValue)
Add singleton String value to MFString function field.MultiTextureObject
addFunction(SFStringObject newValue)
Add singleton SFStringObject value to MFString function field.MultiTextureObject
addMode(java.lang.String newValue)
Add singleton String value to MFString mode field.MultiTextureObject
addMode(SFStringObject newValue)
Add singleton SFStringObject value to MFString mode field.MultiTextureObject
addSource(java.lang.String newValue)
Add singleton String value to MFString source field.MultiTextureObject
addSource(SFStringObject newValue)
Add singleton SFStringObject value to MFString source field.MultiTextureObject
addTexture(ProtoInstanceObject newValue)
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for texture field.MultiTextureObject
addTexture(X3DNode newValue)
Add single child node to existing array of texture nodes (if any).void
addTexture(X3DNode[] newValue)
Add array of child texture nodes to array of existing nodes (if any).MultiTextureObject
clearFunction()
Utility method to clear MFString value of function field.MultiTextureObject
clearIS()
Utility method to clear SFNode value of IS field.MultiTextureObject
clearMetadata()
Utility method to clear SFNode value of metadata field.MultiTextureObject
clearMode()
Utility method to clear MFString value of mode field.MultiTextureObject
clearSource()
Utility method to clear MFString value of source field.MultiTextureObject
clearTexture()
Utility method to clear MFNode value of texture 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
getAlpha()
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named alpha.float[]
getColor()
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.java.lang.String
getComponent()
Defines X3D component for the MultiTexture element: Texturingint
getComponentLevel()
Provides default X3D component level for this element: 2java.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: MultiTexturejava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.java.lang.String[]
getFunction()
Provide array of String enumeration results (baseType MFString) ['"COMPLEMENT"' | '"ALPHAREPLICATE"' | '""' | '"etc."'] from inputOutput MFString field named function.java.util.ArrayList<java.lang.String>
getFunctionList()
Utility method to get ArrayList value of MFString function field, similar togetFunction()
.java.lang.String
getFunctionString()
Utility method to get String value of MFString function field, similar togetFunction()
.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.java.lang.String[]
getMode()
Provide array of String enumeration results (baseType MFString) ['"ADD"' | '"ADDSIGNED"' | '"ADDSIGNED2X"' | '"ADDSMOOTH"' | '"BLENDCURRENTALPHA"' | '"BLENDDIFFUSEALPHA"' | '"BLENDFACTORALPHA"' | '"BLENDTEXTUREALPHA"' | '"DOTPRODUCT3"' | '"MODULATE"' | '"MODULATE2X"' | '"MODULATE4X"' | '"MODULATEALPHA_ADDCOLOR"' | '"MODULATEINVALPHA_ADDCOLOR"' | '"MODULATEINVCOLOR_ADDALPHA"' | '"OFF"' | '"REPLACE"' | '"SELECTARG1"' | '"SELECTARG2"' | '"SUBTRACT"' | '"etc."'] from inputOutput MFString field named mode.java.util.ArrayList<java.lang.String>
getModeList()
Utility method to get ArrayList value of MFString mode field, similar togetMode()
.java.lang.String
getModeString()
Utility method to get String value of MFString mode field, similar togetMode()
.java.lang.String[]
getSource()
Provide array of String enumeration results (baseType MFString) ['"DIFFUSE"' | '"FACTOR"' | '"SPECULAR"' | '""' | '"etc."'] from inputOutput MFString field named source.java.util.ArrayList<java.lang.String>
getSourceList()
Utility method to get ArrayList value of MFString source field, similar togetSource()
.java.lang.String
getSourceString()
Utility method to get String value of MFString source field, similar togetSource()
.X3DNode[]
getTexture()
Provide array of X3DTextureNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field texture.java.util.ArrayList<X3DNode>
getTextureList()
Utility method to get ArrayList value of MFNode texture field, similar togetTexture()
.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.boolean
hasTexture()
Indicate whether an object is available for inputOutput MFNode field texture.void
initialize()
Initialize all member variables to default values.MultiTextureObject
setAlpha(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetAlpha(float)
.MultiTextureObject
setAlpha(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named alpha.MultiTextureObject
setAlpha(SFFloatObject newValue)
Assign typed object value to SFFloat alpha field, similar tosetAlpha(float)
.MultiTextureObject
setColor(double[] newArray)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetColor(float[])
.MultiTextureObject
setColor(double red, double green, double blue)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetColor(float[])
.MultiTextureObject
setColor(float[] newValue)
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.MultiTextureObject
setColor(float red, float green, float blue)
Assign values to SFColor color field, similar tosetColor(float[])
.MultiTextureObject
setColor(SFColorObject newValue)
Assign typed object value to SFColor color field, similar tosetColor(float[])
.MultiTextureObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.MultiTextureObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.MultiTextureObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.MultiTextureObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.MultiTextureObject
setFunction(java.lang.String newValue)
Assign singleton String value to MFString function field, similar tosetFunction(String[])
.MultiTextureObject
setFunction(java.lang.String[] newValue)
Accessor method to assign String enumeration array (""COMPLEMENT"" | ""ALPHAREPLICATE"" | """") to inputOutput MFString field named function.MultiTextureObject
setFunction(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString function field, similar tosetFunction(String[])
.MultiTextureObject
setFunction(MFStringObject newValue)
Assign typed object value to MFString function field, similar tosetFunction(String[])
.MultiTextureObject
setFunction(SFStringObject newValue)
Assign single SFString object value to MFString function field, similar tosetFunction(String[])
.MultiTextureObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.MultiTextureObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.MultiTextureObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.MultiTextureObject
setMode(java.lang.String newValue)
Assign singleton String value to MFString mode field, similar tosetMode(String[])
.MultiTextureObject
setMode(java.lang.String[] newValue)
Accessor method to assign String enumeration array (""ADD"" | ""ADDSIGNED"" | ""ADDSIGNED2X"" | ""ADDSMOOTH"" | ""BLENDCURRENTALPHA"" | ""BLENDDIFFUSEALPHA"" | ""BLENDFACTORALPHA"" | ""BLENDTEXTUREALPHA"" | ""DOTPRODUCT3"" | ""MODULATE"" | ""MODULATE2X"" | ""MODULATE4X"" | ""MODULATEALPHA_ADDCOLOR"" | ""MODULATEINVALPHA_ADDCOLOR"" | ""MODULATEINVCOLOR_ADDALPHA"" | ""OFF"" | ""REPLACE"" | ""SELECTARG1"" | ""SELECTARG2"" | ""SUBTRACT"") to inputOutput MFString field named mode.MultiTextureObject
setMode(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString mode field, similar tosetMode(String[])
.MultiTextureObject
setMode(MFStringObject newValue)
Assign typed object value to MFString mode field, similar tosetMode(String[])
.MultiTextureObject
setMode(SFStringObject newValue)
Assign single SFString object value to MFString mode field, similar tosetMode(String[])
.MultiTextureObject
setSource(java.lang.String newValue)
Assign singleton String value to MFString source field, similar tosetSource(String[])
.MultiTextureObject
setSource(java.lang.String[] newValue)
Accessor method to assign String enumeration array (""DIFFUSE"" | ""FACTOR"" | ""SPECULAR"" | """") to inputOutput MFString field named source.MultiTextureObject
setSource(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString source field, similar tosetSource(String[])
.MultiTextureObject
setSource(MFStringObject newValue)
Assign typed object value to MFString source field, similar tosetSource(String[])
.MultiTextureObject
setSource(SFStringObject newValue)
Assign single SFString object value to MFString source field, similar tosetSource(String[])
.MultiTextureObject
setTexture(java.util.ArrayList<X3DTextureNode> newValue)
Assign ArrayList value of MFNode texture field, similar tosetTexture(X3DNode[])
.void
setTexture(X3DNode newValue)
Set single child texture node, replacing prior array of existing nodes (if any).MultiTextureObject
setTexture(X3DNode[] newValue)
Accessor method to assign X3DTextureNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field texture.MultiTextureObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.MultiTextureObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.MultiTextureObject
setUSE(MultiTextureObject 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
-
FUNCTION_COMPLEMENT
public static final java.lang.String FUNCTION_COMPLEMENTTooltip: Invert argument x as (1 - x). MFString field named function with X3DUOM simpleType multiTextureFunctionValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "COMPLEMENT" (Java syntax) or '"COMPLEMENT"' (XML syntax). -
FUNCTION_ALPHAREPLICATE
public static final java.lang.String FUNCTION_ALPHAREPLICATETooltip: Replicate alpha information to all color channels before operation completes. MFString field named function with X3DUOM simpleType multiTextureFunctionValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ALPHAREPLICATE" (Java syntax) or '"ALPHAREPLICATE"' (XML syntax). -
FUNCTION_
public static final java.lang.String FUNCTION_Tooltip: No function is applied - empty SFString is allowed value within MFString array. MFString field named function with X3DUOM simpleType multiTextureFunctionValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "" (Java syntax) or '""' (XML syntax). -
MODE_ADD
public static final java.lang.String MODE_ADDMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADD" (Java syntax) or '"ADD"' (XML syntax). -
MODE_ADDSIGNED
public static final java.lang.String MODE_ADDSIGNEDMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADDSIGNED" (Java syntax) or '"ADDSIGNED"' (XML syntax). -
MODE_ADDSIGNED2X
public static final java.lang.String MODE_ADDSIGNED2XMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADDSIGNED2X" (Java syntax) or '"ADDSIGNED2X"' (XML syntax). -
MODE_ADDSMOOTH
public static final java.lang.String MODE_ADDSMOOTHMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADDSMOOTH" (Java syntax) or '"ADDSMOOTH"' (XML syntax). -
MODE_BLENDCURRENTALPHA
public static final java.lang.String MODE_BLENDCURRENTALPHAMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDCURRENTALPHA" (Java syntax) or '"BLENDCURRENTALPHA"' (XML syntax). -
MODE_BLENDDIFFUSEALPHA
public static final java.lang.String MODE_BLENDDIFFUSEALPHAMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDDIFFUSEALPHA" (Java syntax) or '"BLENDDIFFUSEALPHA"' (XML syntax). -
MODE_BLENDFACTORALPHA
public static final java.lang.String MODE_BLENDFACTORALPHAMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDFACTORALPHA" (Java syntax) or '"BLENDFACTORALPHA"' (XML syntax). -
MODE_BLENDTEXTUREALPHA
public static final java.lang.String MODE_BLENDTEXTUREALPHAMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDTEXTUREALPHA" (Java syntax) or '"BLENDTEXTUREALPHA"' (XML syntax). -
MODE_DOTPRODUCT3
public static final java.lang.String MODE_DOTPRODUCT3MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "DOTPRODUCT3" (Java syntax) or '"DOTPRODUCT3"' (XML syntax). -
MODE_MODULATE
public static final java.lang.String MODE_MODULATEMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATE" (Java syntax) or '"MODULATE"' (XML syntax). -
MODE_MODULATE2X
public static final java.lang.String MODE_MODULATE2XMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATE2X" (Java syntax) or '"MODULATE2X"' (XML syntax). -
MODE_MODULATE4X
public static final java.lang.String MODE_MODULATE4XMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATE4X" (Java syntax) or '"MODULATE4X"' (XML syntax). -
MODE_MODULATEALPHA_ADDCOLOR
public static final java.lang.String MODE_MODULATEALPHA_ADDCOLORMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATEALPHA_ADDCOLOR" (Java syntax) or '"MODULATEALPHA_ADDCOLOR"' (XML syntax). -
MODE_MODULATEINVALPHA_ADDCOLOR
public static final java.lang.String MODE_MODULATEINVALPHA_ADDCOLORMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATEINVALPHA_ADDCOLOR" (Java syntax) or '"MODULATEINVALPHA_ADDCOLOR"' (XML syntax). -
MODE_MODULATEINVCOLOR_ADDALPHA
public static final java.lang.String MODE_MODULATEINVCOLOR_ADDALPHAMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATEINVCOLOR_ADDALPHA" (Java syntax) or '"MODULATEINVCOLOR_ADDALPHA"' (XML syntax). -
MODE_OFF
public static final java.lang.String MODE_OFFMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "OFF" (Java syntax) or '"OFF"' (XML syntax). -
MODE_REPLACE
public static final java.lang.String MODE_REPLACEMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "REPLACE" (Java syntax) or '"REPLACE"' (XML syntax). -
MODE_SELECTARG1
public static final java.lang.String MODE_SELECTARG1MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SELECTARG1" (Java syntax) or '"SELECTARG1"' (XML syntax). -
MODE_SELECTARG2
public static final java.lang.String MODE_SELECTARG2MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SELECTARG2" (Java syntax) or '"SELECTARG2"' (XML syntax). -
MODE_SUBTRACT
public static final java.lang.String MODE_SUBTRACTMFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SUBTRACT" (Java syntax) or '"SUBTRACT"' (XML syntax). -
SOURCE_DIFFUSE
public static final java.lang.String SOURCE_DIFFUSEMFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "DIFFUSE" (Java syntax) or '"DIFFUSE"' (XML syntax). -
SOURCE_FACTOR
public static final java.lang.String SOURCE_FACTORMFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "FACTOR" (Java syntax) or '"FACTOR"' (XML syntax). -
SOURCE_SPECULAR
public static final java.lang.String SOURCE_SPECULARMFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SPECULAR" (Java syntax) or '"SPECULAR"' (XML syntax). -
SOURCE_
public static final java.lang.String SOURCE_MFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "" (Java syntax) or '""' (XML syntax). -
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: MultiTexture.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the MultiTexture element: Texturing- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Texturing component level for this element: 2- See Also:
- Constant Field Values
-
ALPHA_DEFAULT_VALUE
public static final float ALPHA_DEFAULT_VALUESFFloat field named alpha has default value 1f (Java syntax) or 1 (XML syntax).- See Also:
- Constant Field Values
-
COLOR_DEFAULT_VALUE
public static final float[] COLOR_DEFAULT_VALUESFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax). -
FUNCTION_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.String> FUNCTION_DEFAULT_VALUEMFString field named function has default value equal to an empty list. -
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). -
MODE_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.String> MODE_DEFAULT_VALUEMFString field named mode has default value equal to an empty list. -
SOURCE_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.String> SOURCE_DEFAULT_VALUEMFString field named source has default value equal to an empty list. -
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_ALPHA
public static final java.lang.String fromField_ALPHAfromField ROUTE name for SFFloat field named alpha.- See Also:
- Constant Field Values
-
toField_ALPHA
public static final java.lang.String toField_ALPHAtoField ROUTE name for SFFloat field named alpha.- See Also:
- Constant Field Values
-
fromField_COLOR
public static final java.lang.String fromField_COLORfromField ROUTE name for SFColor field named color.- See Also:
- Constant Field Values
-
toField_COLOR
public static final java.lang.String toField_COLORtoField ROUTE name for SFColor field named color.- See Also:
- Constant Field Values
-
fromField_FUNCTION
public static final java.lang.String fromField_FUNCTIONfromField ROUTE name for MFString field named function.- See Also:
- Constant Field Values
-
toField_FUNCTION
public static final java.lang.String toField_FUNCTIONtoField ROUTE name for MFString field named function.- 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_MODE
public static final java.lang.String fromField_MODEfromField ROUTE name for MFString field named mode.- See Also:
- Constant Field Values
-
toField_MODE
public static final java.lang.String toField_MODEtoField ROUTE name for MFString field named mode.- See Also:
- Constant Field Values
-
fromField_SOURCE
public static final java.lang.String fromField_SOURCEfromField ROUTE name for MFString field named source.- See Also:
- Constant Field Values
-
toField_SOURCE
public static final java.lang.String toField_SOURCEtoField ROUTE name for MFString field named source.- See Also:
- Constant Field Values
-
fromField_TEXTURE
public static final java.lang.String fromField_TEXTUREfromField ROUTE name for MFNode field named texture.- See Also:
- Constant Field Values
-
toField_TEXTURE
public static final java.lang.String toField_TEXTUREtoField ROUTE name for MFNode field named texture.- See Also:
- Constant Field Values
-
-
Constructor Details
-
MultiTextureObject
public MultiTextureObject()Constructor for MultiTextureObject to initialize member variables with default values. -
MultiTextureObject
public MultiTextureObject(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: MultiTexture- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the MultiTexture element: Texturing- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- 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
-
getAlpha
public float getAlpha()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named alpha.
Tooltip: [0,1] The alpha field defines the alpha (1-transparency) base value for mode operations. *- Specified by:
getAlpha
in interfaceMultiTexture
- Returns:
- value of alpha field
-
setAlpha
Accessor method to assign float value to inputOutput SFFloat field named alpha.
Tooltip: [0,1] The alpha field defines the alpha (1-transparency) base value for mode operations. *- Specified by:
setAlpha
in interfaceMultiTexture
- Parameters:
newValue
- is new value for the alpha field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAlpha
Assign typed object value to SFFloat alpha field, similar tosetAlpha(float)
.- Parameters:
newValue
- is new value for the alpha field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAlpha
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetAlpha(float)
.- Parameters:
newValue
- is new value for field- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getColor
public float[] getColor()Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.
Tooltip: [0,1] The color field defines the RGB base values for mode operations.- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
getColor
in interfaceMultiTexture
- Returns:
- value of color field
-
setColor
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.
Tooltip: [0,1] The color field defines the RGB base values for mode operations.- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
setColor
in interfaceMultiTexture
- Parameters:
newValue
- is new value for the color field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setColor
Assign typed object value to SFColor color field, similar tosetColor(float[])
.- Parameters:
newValue
- is new value for the color field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setColor
Assign values to SFColor color field, similar tosetColor(float[])
.- Parameters:
red
- first componentgreen
- second componentblue
- third component- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetColor(float[])
.- Parameters:
red
- first component [0..1]green
- second component [0..1]blue
- third component [0..1]- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetColor(float[])
.- Parameters:
newArray
- is new value for field- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getFunction
public java.lang.String[] getFunction()Provide array of String enumeration results (baseType MFString) ['"COMPLEMENT"' | '"ALPHAREPLICATE"' | '""' | '"etc."'] from inputOutput MFString field named function.
Tooltip: function operators COMPLEMENT or ALPHAREPLICATE can be applied after the mode blending operation. Empty string value "" indicates that no function operation is applied for that stage.- Hint: include the same number of function values as textures, otherwise the default of no function operation is applied for each remaining stage.
- Hint: X3D Architecture Table 18.5 Values for the function field https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-ValuesForFunctionField for further details.
Available enumeration values for string comparison:COMPLEMENT
,ALPHAREPLICATE
,FUNCTION_
.- Specified by:
getFunction
in interfaceMultiTexture
- Returns:
- value of function field
-
getFunctionList
public java.util.ArrayList<java.lang.String> getFunctionList()Utility method to get ArrayList value of MFString function field, similar togetFunction()
.- Returns:
- value of function field
-
getFunctionString
public java.lang.String getFunctionString()Utility method to get String value of MFString function field, similar togetFunction()
.- Returns:
- value of function field
-
setFunction
Accessor method to assign String enumeration array (""COMPLEMENT"" | ""ALPHAREPLICATE"" | """") to inputOutput MFString field named function.
Hint: authors have option to choose from an extendible list of predefined enumeration values (COMPLEMENT
,ALPHAREPLICATE
,FUNCTION_
).
Tooltip: function operators COMPLEMENT or ALPHAREPLICATE can be applied after the mode blending operation. Empty string value "" indicates that no function operation is applied for that stage.- Hint: include the same number of function values as textures, otherwise the default of no function operation is applied for each remaining stage.
- Hint: X3D Architecture Table 18.5 Values for the function field https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-ValuesForFunctionField for further details.
- Specified by:
setFunction
in interfaceMultiTexture
- Parameters:
newValue
- is new value for the function field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFunction
Assign typed object value to MFString function field, similar tosetFunction(String[])
.- Parameters:
newValue
- is new value for the function field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFunction
Assign single SFString object value to MFString function field, similar tosetFunction(String[])
.- Parameters:
newValue
- is new value for the function field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setFunction
Assign singleton String value to MFString function field, similar tosetFunction(String[])
.- Parameters:
newValue
- is new value for the function field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setFunction
Assign ArrayList value of MFString function field, similar tosetFunction(String[])
.- Parameters:
newValue
- is new value for the function field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearFunction
Utility method to clear MFString value of function field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addFunction
Add singleton String value to MFString function field.- Parameters:
newValue
- is new value to add to the function field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addFunction
Add singleton SFStringObject value to MFString function field.- Parameters:
newValue
- is new value to add to the function field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
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:
MultiTextureObject
- 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:
MultiTextureObject
- 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 interfaceMultiTexture
- Specified by:
getMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DTextureNode
- 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 interfaceMultiTexture
- Specified by:
setMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DTextureNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
MultiTextureObject
- 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:
MultiTextureObject
- 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:
MultiTextureObject
- 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
-
getMode
public java.lang.String[] getMode()Provide array of String enumeration results (baseType MFString) ['"ADD"' | '"ADDSIGNED"' | '"ADDSIGNED2X"' | '"ADDSMOOTH"' | '"BLENDCURRENTALPHA"' | '"BLENDDIFFUSEALPHA"' | '"BLENDFACTORALPHA"' | '"BLENDTEXTUREALPHA"' | '"DOTPRODUCT3"' | '"MODULATE"' | '"MODULATE2X"' | '"MODULATE4X"' | '"MODULATEALPHA_ADDCOLOR"' | '"MODULATEINVALPHA_ADDCOLOR"' | '"MODULATEINVCOLOR_ADDALPHA"' | '"OFF"' | '"REPLACE"' | '"SELECTARG1"' | '"SELECTARG2"' | '"SUBTRACT"' | '"etc."'] from inputOutput MFString field named mode.
Tooltip: mode field indicates the type of blending operation, both for color and for alpha channel.- Hint: include the same number of mode values as textures, otherwise the default value MODULATE is added for each remaining stage.
- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.3 Multitexture modes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-MultitextureModes for further details.
Available enumeration values for string comparison:ADD
,ADDSIGNED
,ADDSIGNED2X
,ADDSMOOTH
,BLENDCURRENTALPHA
,BLENDDIFFUSEALPHA
,BLENDFACTORALPHA
,BLENDTEXTUREALPHA
,DOTPRODUCT3
,MODULATE
,MODULATE2X
,MODULATE4X
,MODULATEALPHA_ADDCOLOR
,MODULATEINVALPHA_ADDCOLOR
,MODULATEINVCOLOR_ADDALPHA
,OFF
,REPLACE
,SELECTARG1
,SELECTARG2
,SUBTRACT
.- Specified by:
getMode
in interfaceMultiTexture
- Returns:
- value of mode field
-
getModeList
public java.util.ArrayList<java.lang.String> getModeList()Utility method to get ArrayList value of MFString mode field, similar togetMode()
.- Returns:
- value of mode field
-
getModeString
public java.lang.String getModeString()Utility method to get String value of MFString mode field, similar togetMode()
.- Returns:
- value of mode field
-
setMode
Accessor method to assign String enumeration array (""ADD"" | ""ADDSIGNED"" | ""ADDSIGNED2X"" | ""ADDSMOOTH"" | ""BLENDCURRENTALPHA"" | ""BLENDDIFFUSEALPHA"" | ""BLENDFACTORALPHA"" | ""BLENDTEXTUREALPHA"" | ""DOTPRODUCT3"" | ""MODULATE"" | ""MODULATE2X"" | ""MODULATE4X"" | ""MODULATEALPHA_ADDCOLOR"" | ""MODULATEINVALPHA_ADDCOLOR"" | ""MODULATEINVCOLOR_ADDALPHA"" | ""OFF"" | ""REPLACE"" | ""SELECTARG1"" | ""SELECTARG2"" | ""SUBTRACT"") to inputOutput MFString field named mode.
Hint: authors have option to choose from an extendible list of predefined enumeration values (ADD
,ADDSIGNED
,ADDSIGNED2X
,ADDSMOOTH
,BLENDCURRENTALPHA
,BLENDDIFFUSEALPHA
,BLENDFACTORALPHA
,BLENDTEXTUREALPHA
,DOTPRODUCT3
,MODULATE
,MODULATE2X
,MODULATE4X
,MODULATEALPHA_ADDCOLOR
,MODULATEINVALPHA_ADDCOLOR
,MODULATEINVCOLOR_ADDALPHA
,OFF
,REPLACE
,SELECTARG1
,SELECTARG2
,SUBTRACT
).
Tooltip: mode field indicates the type of blending operation, both for color and for alpha channel.- Hint: include the same number of mode values as textures, otherwise the default value MODULATE is added for each remaining stage.
- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.3 Multitexture modes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-MultitextureModes for further details.
- Specified by:
setMode
in interfaceMultiTexture
- Parameters:
newValue
- is new value for the mode field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMode
Assign typed object value to MFString mode field, similar tosetMode(String[])
.- Parameters:
newValue
- is new value for the mode field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMode
Assign single SFString object value to MFString mode field, similar tosetMode(String[])
.- Parameters:
newValue
- is new value for the mode field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setMode
Assign singleton String value to MFString mode field, similar tosetMode(String[])
.- Parameters:
newValue
- is new value for the mode field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setMode
Assign ArrayList value of MFString mode field, similar tosetMode(String[])
.- Parameters:
newValue
- is new value for the mode field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearMode
Utility method to clear MFString value of mode field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addMode
Add singleton String value to MFString mode field.- Parameters:
newValue
- is new value to add to the mode field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addMode
Add singleton SFStringObject value to MFString mode field.- Parameters:
newValue
- is new value to add to the mode field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
getSource
public java.lang.String[] getSource()Provide array of String enumeration results (baseType MFString) ['"DIFFUSE"' | '"FACTOR"' | '"SPECULAR"' | '""' | '"etc."'] from inputOutput MFString field named source.
Tooltip: source field determines whether each image source is treated as DIFFUSE, SPECULAR or a multiplicative FACTOR. Empty string value "" indicates that no source modifier is applied for that stage.- Hint: include the same number of source values as textures, otherwise the default of no source interpretation is applied for each remaining stage.
- Hint: X3D Architecture Table 18.4 Values for the source field https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-ValuesForSourceField for further details.
Available enumeration values for string comparison:DIFFUSE
,FACTOR
,SPECULAR
,SOURCE_
.- Specified by:
getSource
in interfaceMultiTexture
- Returns:
- value of source field
-
getSourceList
public java.util.ArrayList<java.lang.String> getSourceList()Utility method to get ArrayList value of MFString source field, similar togetSource()
.- Returns:
- value of source field
-
getSourceString
public java.lang.String getSourceString()Utility method to get String value of MFString source field, similar togetSource()
.- Returns:
- value of source field
-
setSource
Accessor method to assign String enumeration array (""DIFFUSE"" | ""FACTOR"" | ""SPECULAR"" | """") to inputOutput MFString field named source.
Hint: authors have option to choose from an extendible list of predefined enumeration values (DIFFUSE
,FACTOR
,SPECULAR
,SOURCE_
).
Tooltip: source field determines whether each image source is treated as DIFFUSE, SPECULAR or a multiplicative FACTOR. Empty string value "" indicates that no source modifier is applied for that stage.- Hint: include the same number of source values as textures, otherwise the default of no source interpretation is applied for each remaining stage.
- Hint: X3D Architecture Table 18.4 Values for the source field https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-ValuesForSourceField for further details.
- Specified by:
setSource
in interfaceMultiTexture
- Parameters:
newValue
- is new value for the source field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSource
Assign typed object value to MFString source field, similar tosetSource(String[])
.- Parameters:
newValue
- is new value for the source field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSource
Assign single SFString object value to MFString source field, similar tosetSource(String[])
.- Parameters:
newValue
- is new value for the source field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setSource
Assign singleton String value to MFString source field, similar tosetSource(String[])
.- Parameters:
newValue
- is new value for the source field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setSource
Assign ArrayList value of MFString source field, similar tosetSource(String[])
.- Parameters:
newValue
- is new value for the source field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearSource
Utility method to clear MFString value of source field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addSource
Add singleton String value to MFString source field.- Parameters:
newValue
- is new value to add to the source field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addSource
Add singleton SFStringObject value to MFString source field.- Parameters:
newValue
- is new value to add to the source field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
getTexture
Provide array of X3DTextureNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field texture.
Tooltip: [X3DTextureNode] Contained texture nodes (ImageTexture, MovieTexture, PixelTexture) that map image(s) to surface geometry, defining each of the different texture channels.- Warning: MultiTexture may not contain another MultiTexture node.
- Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured.
- Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
- Hint: X3D Architecture 18 Texturing component https://www.web3d.org/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
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DTextureNode.- Specified by:
getTexture
in interfaceMultiTexture
- Returns:
- value of texture field
- See Also:
X3DTextureNode
-
getTextureList
Utility method to get ArrayList value of MFNode texture field, similar togetTexture()
.- Returns:
- value of texture field
-
setTexture
Accessor method to assign X3DTextureNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field texture.
Tooltip: [X3DTextureNode] Contained texture nodes (ImageTexture, MovieTexture, PixelTexture) that map image(s) to surface geometry, defining each of the different texture channels.- Warning: MultiTexture may not contain another MultiTexture node.
- Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured.
- Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
- Hint: X3D Architecture 18 Texturing component https://www.web3d.org/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
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DTextureNode.- Specified by:
setTexture
in interfaceMultiTexture
- Parameters:
newValue
- is new value for the texture field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTexture
Assign ArrayList value of MFNode texture field, similar tosetTexture(X3DNode[])
.- Parameters:
newValue
- is new value for the texture field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addTexture
Add single child node to existing array of texture nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DTextureNode and ProtoInstance.- Parameters:
newValue
- is new value to be appended the texture field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addTexture
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for texture 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:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addTexture
Add array of child texture nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DTextureNode.- Specified by:
addTexture
in interfaceMultiTexture
- Parameters:
newValue
- is new value array to be appended the texture field.
-
setTexture
Set single child texture node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DTextureNode.- Specified by:
setTexture
in interfaceMultiTexture
- Parameters:
newValue
- is new node for the texture field (restricted to X3DTextureNode)
-
clearTexture
Utility method to clear MFNode value of texture field.- Returns:
MultiTextureObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasTexture
public boolean hasTexture()Indicate whether an object is available for inputOutput MFNode field texture.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
getTexture()
-
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:
MultiTextureObject
- 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:
MultiTextureObject
- 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:
MultiTextureObject
- 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:
MultiTextureObject
- 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:
MultiTextureObject
- 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:
MultiTextureObject
- 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:
MultiTextureObject
- 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:
MultiTextureObject
- 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:
MultiTextureObject
- 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:
MultiTextureObject
- 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)
-