Package org.web3d.x3d.jsail.Texturing
Class MultiTexture
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Texturing.MultiTexture
- All Implemented Interfaces:
X3DNode
,X3DAppearanceChildNode
,MultiTexture
,X3DTextureNode
MultiTexture applies several individual textures to a single geometry node, enabling a variety of visual effects that include light mapping and environment mapping.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Note that SFColor 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.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
MultiTexture 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, PixelTexture, ComposedCubeMapTexture, GeneratedCubeMapTexture, ImageCubeMapTexture, ComposedTexture3D, ImageTexture3D, and PixelTexture3D nodes. Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s, t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.
- Hint: insert Shape and Appearance nodes before adding texture.
- Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
- Warning: the number of textures to be blended may have a significant impact on performance, depending on available graphics hardware capabilities.
- Hint: multitexturing is accomplished using MultiTexture, MultiTextureCoordinate and MultiTextureTransform nodes.
- Hint: Texture coordinates are reapplied (or else recomputed if textureTransform field initially NULL) whenever the corresponding vertex-based geometry changes.
- Hint: X3D Texturing component Figure 18.2 Lightmap example, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#f-Lightmapexample
- Hint: X3D Texturing component Table 18.2: Comparison of single texture and multitexture attributes, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-SingleAndMultitextureAttrs
- Hint: MultiTexture does not need to be included in LoadSensor watchList since any child ImageTexture and MovieTexture nodes of interest can be handled separately.
- Warning: MultiTexture may not contain another MultiTexture node.
Note that SFColor provides a variety of color constants.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final float
SFFloat field named alpha has default value 1f (Java syntax) or 1 (XML syntax).static final float[]
SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).static final String
String constant COMPONENT defines X3D component for the MultiTexture element: Texturingstatic final String
containerField describes typical field relationship of a node to its parent.static final String
SFString field named description has default value equal to an empty string.static final String
fromField ROUTE name for SFFloat field named alpha.static final String
fromField ROUTE name for SFColor field named color.static final String
fromField ROUTE name for SFString field named description.static final String
fromField ROUTE name for MFString field named function.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for MFString field named mode.static final String
fromField ROUTE name for MFString field named source.static final String
fromField ROUTE name for MFNode field named texture.static final String
Tooltip: No function is applied - empty SFString is allowed value within MFString array.static final String
Tooltip: Replicate alpha information to all color channels before operation completes.static final String
Tooltip: Invert argument x as (1 - x).MFString field named function has default value equal to an empty list.static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final int
Integer constant LEVEL provides default X3D Texturing component level for this element: 2static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
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 final String
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 final String
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 final String
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 final String
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 final String
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 final String
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 final String
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).MFString field named mode has default value equal to an empty list.static final String
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 final String
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 final String
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 final String
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 final String
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 final String
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 final String
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 final String
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 final String
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 final String
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 final String
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 final String
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 final String
String constant NAME provides name of this element: MultiTexture.static final String
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).MFString field named source has default value equal to an empty list.static final String
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 final String
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 final String
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 final String
toField ROUTE name for SFFloat field named alpha.static final String
toField ROUTE name for SFColor field named color.static final String
toField ROUTE name for SFString field named description.static final String
toField ROUTE name for MFString field named function.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for MFString field named mode.static final String
toField ROUTE name for MFString field named source.static final String
toField ROUTE name for MFNode field named texture.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
ConstructorDescriptionConstructor for MultiTexture to initialize member variables with default values.MultiTexture
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.addFunction
(String newValue) Add singleton String value to MFString function field.addFunction
(SFString newValue) Add singleton SFString value to MFString function field.Add singleton String value to MFString mode field.Add singleton SFString value to MFString mode field.Add singleton String value to MFString source field.Add singleton SFString value to MFString source field.addTexture
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for texture field.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).Utility method to clear MFString value of function field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear SFNode value of metadata field.Utility method to clear MFString value of mode field.Utility method to clear MFString value of source field.Utility method to clear MFNode value of texture field.findElementByNameValue
(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.findElementByNameValue
(String nameValue, 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.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(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.final String
Defines X3D component for the MultiTexture element: Texturingfinal int
Provides default X3D component level for this element: 2final String
containerField describes typical field relationship of a node to its parent.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.Provide String value from inputOutput SFString field named description.final String
Provides name of this element: MultiTexturegetFieldType
(String fieldName) Indicate type corresponding to given fieldName.String[]
Provide array of String enumeration results (baseType MFString) ['"COMPLEMENT"' | '"ALPHAREPLICATE"' | '""' | '"etc."'] from inputOutput MFString field named function.Utility method to get ArrayList value of MFString function field, similar togetFunction()
.Utility method to get String value of MFString function field, similar togetFunction()
.Provide String value from inputOutput SFString field named id.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.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.Utility method to get ArrayList value of MFString mode field, similar togetMode()
.Utility method to get String value of MFString mode field, similar togetMode()
.String[]
Provide array of String enumeration results (baseType MFString) ['"DIFFUSE"' | '"FACTOR"' | '"SPECULAR"' | '""' | '"etc."'] from inputOutput MFString field named source.Utility method to get ArrayList value of MFString source field, similar togetSource()
.Utility method to get String value of MFString source field, similar togetSource()
.X3DNode[]
Provide array of org.web3d.x3d.sai.Texturing.X3DSingleTextureNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field texture.Utility method to get ArrayList value of MFNode texture field, similar togetTexture()
.getUSE()
Provide String value from inputOutput SFString field named USE.boolean
hasElementByNameValue
(String nameValue, 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
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.boolean
Indicate whether an object is available for inputOutput MFNode field texture.final void
Initialize all member variables to default values.setAlpha
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetAlpha(float)
.setAlpha
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named alpha.Assign typed object value to SFFloat alpha field, similar tosetAlpha(float)
.setColor
(double[] newArray) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetColor(float[])
.setColor
(double red, double green, double blue) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetColor(float[])
.setColor
(float[] newValue) Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.setColor
(float red, float green, float blue) Assign values to SFColor color field, similar tosetColor(float[])
.Assign typed object value to SFColor color field, similar tosetColor(float[])
.final MultiTexture
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final MultiTexture
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final MultiTexture
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.setDescription
(String newValue) Accessor method to assign String value to inputOutput SFString field named description.setDescription
(SFString newValue) Assign typed object value to SFString description field, similar tosetDescription(String)
.setFunction
(String newValue) Assign singleton String value to MFString function field, similar tosetFunction(String[])
.setFunction
(String[] newValue) Accessor method to assign String enumeration array (""COMPLEMENT"" | ""ALPHAREPLICATE"" | """") to inputOutput MFString field named function.setFunction
(ArrayList<String> newValue) Assign ArrayList value of MFString function field, similar tosetFunction(String[])
.setFunction
(MFString newValue) Assign typed object value to MFString function field, similar tosetFunction(String[])
.setFunction
(SFString newValue) Assign single SFString object value to MFString function field, similar tosetFunction(String[])
.final MultiTexture
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.Assign singleton String value to MFString mode field, similar tosetMode(String[])
.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.Assign ArrayList value of MFString mode field, similar tosetMode(String[])
.Assign typed object value to MFString mode field, similar tosetMode(String[])
.Assign single SFString object value to MFString mode field, similar tosetMode(String[])
.Assign singleton String value to MFString source field, similar tosetSource(String[])
.Accessor method to assign String enumeration array (""DIFFUSE"" | ""FACTOR"" | ""SPECULAR"" | """") to inputOutput MFString field named source.Assign ArrayList value of MFString source field, similar tosetSource(String[])
.Assign typed object value to MFString source field, similar tosetSource(String[])
.Assign single SFString object value to MFString source field, similar tosetSource(String[])
.setTexture
(ArrayList<X3DSingleTextureNode> newValue) Assign ArrayList value of MFNode texture field, similar tosetTexture(org.web3d.x3d.sai.Core.X3DNode[])
.void
setTexture
(X3DNode newValue) Set single child texture node, replacing prior array of existing nodes (if any).setTexture
(X3DNode[] newValue) Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field texture.final MultiTexture
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(MultiTexture DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.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
getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
FUNCTION_COMPLEMENT
Tooltip: 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).- See Also:
-
FUNCTION_ALPHAREPLICATE
Tooltip: 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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
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).- See Also:
-
NAME
String constant NAME provides name of this element: MultiTexture.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the MultiTexture element: Texturing- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Texturing component level for this element: 2- See Also:
-
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:
-
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). -
DESCRIPTION_DEFAULT_VALUE
SFString field named description has default value equal to an empty string.- See Also:
-
FUNCTION_DEFAULT_VALUE
-
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
-
SOURCE_DEFAULT_VALUE
-
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "texture";
containerField_ALLOWED_VALUES = {"texture" }; type X3DUOM containerFieldChoicesX3DTexture2DNode- See Also:
-
fromField_ALPHA
fromField ROUTE name for SFFloat field named alpha.- See Also:
-
toField_ALPHA
toField ROUTE name for SFFloat field named alpha.- See Also:
-
fromField_COLOR
fromField ROUTE name for SFColor field named color.- See Also:
-
toField_COLOR
toField ROUTE name for SFColor field named color.- See Also:
-
fromField_DESCRIPTION
fromField ROUTE name for SFString field named description.- See Also:
-
toField_DESCRIPTION
toField ROUTE name for SFString field named description.- See Also:
-
fromField_FUNCTION
fromField ROUTE name for MFString field named function.- See Also:
-
toField_FUNCTION
toField ROUTE name for MFString field named function.- See Also:
-
fromField_IS
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_MODE
fromField ROUTE name for MFString field named mode.- See Also:
-
toField_MODE
-
fromField_SOURCE
fromField ROUTE name for MFString field named source.- See Also:
-
toField_SOURCE
toField ROUTE name for MFString field named source.- See Also:
-
fromField_TEXTURE
fromField ROUTE name for MFNode field named texture.- See Also:
-
toField_TEXTURE
toField ROUTE name for MFNode field named texture.- See Also:
-
-
Constructor Details
-
MultiTexture
public MultiTexture()Constructor for MultiTexture to initialize member variables with default values. -
MultiTexture
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
Provides name of this element: MultiTexture- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
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
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:
-
getAccessType
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:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
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:
MultiTexture
- 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:
MultiTexture
- 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:
MultiTexture
- 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:
MultiTexture
- 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:
MultiTexture
- 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:
MultiTexture
- 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:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDescription
Provide String value from inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose of the url asset.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
getDescription
in interfaceMultiTexture
- Specified by:
getDescription
in interfaceX3DTextureNode
- Returns:
- value of description field
-
setDescription
Accessor method to assign String value to inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose of the url asset.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
setDescription
in interfaceMultiTexture
- Specified by:
setDescription
in interfaceX3DTextureNode
- Parameters:
newValue
- is new value for the description field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDescription
Assign typed object value to SFString description field, similar tosetDescription(String)
.- Parameters:
newValue
- is new value for the description field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /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
Utility method to get ArrayList value of MFString function field, similar togetFunction()
.- Returns:
- value of function field
-
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-ValuesForFunctionField for further details.
- Specified by:
setFunction
in interfaceMultiTexture
- Parameters:
newValue
- is new value for the function field.- Returns:
MultiTexture
- 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:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setFunction
Assign singleton String value to MFString function field, similar tosetFunction(String[])
.- Parameters:
newValue
- is new value for the function field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setFunction
Assign ArrayList value of MFString function field, similar tosetFunction(String[])
.- Parameters:
newValue
- is new value for the function field.- Returns:
MultiTexture
- 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. This method does not initialize withFUNCTION_DEFAULT_VALUE.- Returns:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addFunction
Add singleton SFString value to MFString function field.- Parameters:
newValue
- is new value to add to the function field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
MultiTexture
- 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:
-
getMetadata
Provide org.web3d.x3d.sai.Core.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:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /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
-
getModeString
-
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-MultitextureModes for further details.
- Specified by:
setMode
in interfaceMultiTexture
- Parameters:
newValue
- is new value for the mode field.- Returns:
MultiTexture
- 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:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setMode
Assign singleton String value to MFString mode field, similar tosetMode(String[])
.- Parameters:
newValue
- is new value for the mode field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setMode
Assign ArrayList value of MFString mode field, similar tosetMode(String[])
.- Parameters:
newValue
- is new value for the mode field.- Returns:
MultiTexture
- 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. This method does not initialize withMODE_DEFAULT_VALUE.- Returns:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addMode
Add singleton SFString value to MFString mode field.- Parameters:
newValue
- is new value to add to the mode field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /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
Utility method to get ArrayList value of MFString source field, similar togetSource()
.- Returns:
- value of source field
-
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-ValuesForSourceField for further details.
- Specified by:
setSource
in interfaceMultiTexture
- Parameters:
newValue
- is new value for the source field.- Returns:
MultiTexture
- 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:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setSource
Assign singleton String value to MFString source field, similar tosetSource(String[])
.- Parameters:
newValue
- is new value for the source field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setSource
Assign ArrayList value of MFString source field, similar tosetSource(String[])
.- Parameters:
newValue
- is new value for the source field.- Returns:
MultiTexture
- 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. This method does not initialize withSOURCE_DEFAULT_VALUE.- Returns:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addSource
Add singleton SFString value to MFString source field.- Parameters:
newValue
- is new value to add to the source field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getTexture
Provide array of org.web3d.x3d.sai.Texturing.X3DSingleTextureNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field texture.
Tooltip: [X3DSingleTextureNode] Contained texture nodes (ImageTexture, MovieTexture, PixelTexture) that map image(s) to surface geometry, defining each of the different texture channels.- Warning: MultiTexture may not contain another MultiTexture node.
- Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured.
- Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
- Hint: X3D Architecture 18 Texturing component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html
- Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texture3D.html
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DSingleTextureNode.- Specified by:
getTexture
in interfaceMultiTexture
- Returns:
- value of texture field
- See Also:
-
getTextureList
Utility method to get ArrayList value of MFNode texture field, similar togetTexture()
.- Returns:
- value of texture field
-
setTexture
Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field texture.
Tooltip: [X3DSingleTextureNode] Contained texture nodes (ImageTexture, MovieTexture, PixelTexture) that map image(s) to surface geometry, defining each of the different texture channels.- Warning: MultiTexture may not contain another MultiTexture node.
- Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured.
- Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
- Hint: X3D Architecture 18 Texturing component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html
- Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texture3D.html
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DSingleTextureNode.- Specified by:
setTexture
in interfaceMultiTexture
- Parameters:
newValue
- is new value for the texture field.- Returns:
MultiTexture
- 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(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the texture field.- Returns:
MultiTexture
- 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 X3DSingleTextureNode and ProtoInstance.- Parameters:
newValue
- is new value to be appended the texture field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addTexture
Add single ProtoInstance (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:
MultiTexture
- 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 X3DSingleTextureNode.- 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 X3DSingleTextureNode.- Specified by:
setTexture
in interfaceMultiTexture
- Parameters:
newValue
- is new node for the texture field (restricted to X3DSingleTextureNode)
-
clearTexture
Utility method to clear MFNode value of texture field. This method does not initialize withTEXTURE_DEFAULT_VALUE.- Returns:
MultiTexture
- 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:
-
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:
-
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:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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:
-
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:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
MultiTexture
- 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:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
MultiTexture
- 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:
MultiTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
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:
-
toStringClassicVRML
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:
-
toStringVRML97
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:
-
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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:
-
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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:
-
hasElementByNameValue
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:
-
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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:
-
hasNodeByDEF
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:
-
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. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-