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
public class MultiTexture
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 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:
X3D Abstract Specification: MultiTexture, X3D Tooltips: MultiTexture, X3D Scene Authoring Hints: Images

  • 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: Texturing
    static java.lang.String containerField_DEFAULT_VALUE
    containerField describes typical field relationship of a node to its parent.
    static java.lang.String DESCRIPTION_DEFAULT_VALUE
    SFString field named description has default value equal to an empty string.
    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_DESCRIPTION
    fromField ROUTE name for SFString field named description.
    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 IS 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: 2
    static 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_DESCRIPTION
    toField ROUTE name for SFString field named description.
    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

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

    validationResult

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    MultiTexture addComments​(java.lang.String newComment)
    Add comment as String to contained commentsList.
    MultiTexture addComments​(java.lang.String[] newComments)
    Add comments as String[] array to contained commentsList.
    MultiTexture addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock to contained commentsList.
    MultiTexture addFunction​(java.lang.String newValue)
    Add singleton String value to MFString function field.
    MultiTexture addFunction​(SFString newValue)
    Add singleton SFString value to MFString function field.
    MultiTexture addMode​(java.lang.String newValue)
    Add singleton String value to MFString mode field.
    MultiTexture addMode​(SFString newValue)
    Add singleton SFString value to MFString mode field.
    MultiTexture addSource​(java.lang.String newValue)
    Add singleton String value to MFString source field.
    MultiTexture addSource​(SFString newValue)
    Add singleton SFString value to MFString source field.
    MultiTexture addTexture​(ProtoInstance newValue)
    Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for texture field.
    MultiTexture 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).
    MultiTexture clearFunction()
    Utility method to clear MFString value of function field.
    MultiTexture clearIS()
    Utility method to clear SFNode value of IS field.
    MultiTexture clearMetadata()
    Utility method to clear SFNode value of metadata field.
    MultiTexture clearMode()
    Utility method to clear MFString value of mode field.
    MultiTexture clearSource()
    Utility method to clear MFString value of source field.
    MultiTexture 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: Texturing
    int getComponentLevel()
    Provides default X3D component level for this element: 2
    java.lang.String getContainerFieldDefault()
    containerField describes typical field relationship of a node to its parent.
    java.lang.String 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 getDescription()
    Provide String value from inputOutput SFString field named description.
    java.lang.String getElementName()
    Provides name of this element: MultiTexture
    java.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 to getFunction().
    java.lang.String getFunctionString()
    Utility method to get String value of MFString function field, similar to getFunction().
    IS getIS()
    Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.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 to getMode().
    java.lang.String getModeString()
    Utility method to get String value of MFString mode field, similar to getMode().
    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 to getSource().
    java.lang.String getSourceString()
    Utility method to get String value of MFString source field, similar to getSource().
    X3DNode[] 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.
    java.util.ArrayList<X3DNode> getTextureList()
    Utility method to get ArrayList value of MFNode texture field, similar to getTexture().
    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.
    MultiTexture setAlpha​(double newValue)
    Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAlpha(float).
    MultiTexture setAlpha​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named alpha.
    MultiTexture setAlpha​(SFFloat newValue)
    Assign typed object value to SFFloat alpha field, similar to setAlpha(float).
    MultiTexture setColor​(double[] newArray)
    Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).
    MultiTexture setColor​(double red, double green, double blue)
    Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).
    MultiTexture setColor​(float[] newValue)
    Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.
    MultiTexture setColor​(float red, float green, float blue)
    Assign values to SFColor color field, similar to setColor(float[]).
    MultiTexture setColor​(SFColor newValue)
    Assign typed object value to SFColor color field, similar to setColor(float[]).
    MultiTexture setCssClass​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named class.
    MultiTexture setCssClass​(SFString newValue)
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    MultiTexture setDEF​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named DEF.
    MultiTexture setDEF​(SFString newValue)
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    MultiTexture setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    MultiTexture setDescription​(SFString newValue)
    Assign typed object value to SFString description field, similar to setDescription(String).
    MultiTexture setFunction​(java.lang.String newValue)
    Assign singleton String value to MFString function field, similar to setFunction(String[]).
    MultiTexture setFunction​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""COMPLEMENT"" | ""ALPHAREPLICATE"" | """") to inputOutput MFString field named function.
    MultiTexture setFunction​(java.util.ArrayList<java.lang.String> newValue)
    Assign ArrayList value of MFString function field, similar to setFunction(String[]).
    MultiTexture setFunction​(MFString newValue)
    Assign typed object value to MFString function field, similar to setFunction(String[]).
    MultiTexture setFunction​(SFString newValue)
    Assign single SFString object value to MFString function field, similar to setFunction(String[]).
    MultiTexture setIS​(IS newValue)
    Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
    MultiTexture setMetadata​(ProtoInstance newValue)
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    MultiTexture setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    MultiTexture setMode​(java.lang.String newValue)
    Assign singleton String value to MFString mode field, similar to setMode(String[]).
    MultiTexture 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.
    MultiTexture setMode​(java.util.ArrayList<java.lang.String> newValue)
    Assign ArrayList value of MFString mode field, similar to setMode(String[]).
    MultiTexture setMode​(MFString newValue)
    Assign typed object value to MFString mode field, similar to setMode(String[]).
    MultiTexture setMode​(SFString newValue)
    Assign single SFString object value to MFString mode field, similar to setMode(String[]).
    MultiTexture setSource​(java.lang.String newValue)
    Assign singleton String value to MFString source field, similar to setSource(String[]).
    MultiTexture setSource​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""DIFFUSE"" | ""FACTOR"" | ""SPECULAR"" | """") to inputOutput MFString field named source.
    MultiTexture setSource​(java.util.ArrayList<java.lang.String> newValue)
    Assign ArrayList value of MFString source field, similar to setSource(String[]).
    MultiTexture setSource​(MFString newValue)
    Assign typed object value to MFString source field, similar to setSource(String[]).
    MultiTexture setSource​(SFString newValue)
    Assign single SFString object value to MFString source field, similar to setSource(String[]).
    MultiTexture setTexture​(java.util.ArrayList<X3DSingleTextureNode> newValue)
    Assign ArrayList value of MFNode texture field, similar to setTexture(org.web3d.x3d.sai.Core.X3DNode[]).
    void setTexture​(X3DNode newValue)
    Set single child texture node, replacing prior array of existing nodes (if any).
    MultiTexture 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.
    MultiTexture setUSE​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named USE.
    MultiTexture setUSE​(SFString newValue)
    Assign typed object value to SFString USE field, similar to setUSE(String).
    MultiTexture setUSE​(MultiTexture DEFnode)
    Assign a USE reference to another DEF node of same node type, similar to setUSE(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

    addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

    Methods inherited from class java.lang.Object

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

  • Field Details

    • FUNCTION_COMPLEMENT

      public static final java.lang.String 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:
      XML Schema: multiTextureFunctionValues, Constant Field Values

    • FUNCTION_ALPHAREPLICATE

      public static final java.lang.String 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:
      XML Schema: multiTextureFunctionValues, Constant Field Values

    • 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).
      See Also:
      XML Schema: multiTextureFunctionValues, Constant Field Values

    • MODE_ADD

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_ADDSIGNED

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_ADDSIGNED2X

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_ADDSMOOTH

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_BLENDCURRENTALPHA

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_BLENDDIFFUSEALPHA

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_BLENDFACTORALPHA

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_BLENDTEXTUREALPHA

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_DOTPRODUCT3

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_MODULATE

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_MODULATE2X

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_MODULATE4X

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_MODULATEALPHA_ADDCOLOR

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_MODULATEINVALPHA_ADDCOLOR

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_MODULATEINVCOLOR_ADDALPHA

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_OFF

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_REPLACE

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_SELECTARG1

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_SELECTARG2

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • MODE_SUBTRACT

      public static final 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).
      See Also:
      XML Schema: multiTextureModeValues, Constant Field Values

    • SOURCE_DIFFUSE

      public static final 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).
      See Also:
      XML Schema: multiTextureSourceValues, Constant Field Values

    • SOURCE_FACTOR

      public static final 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).
      See Also:
      XML Schema: multiTextureSourceValues, Constant Field Values

    • SOURCE_SPECULAR

      public static final 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).
      See Also:
      XML Schema: multiTextureSourceValues, Constant Field Values

    • 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).
      See Also:
      XML Schema: multiTextureSourceValues, Constant Field Values

    • NAME

      public static final java.lang.String NAME
      String constant NAME provides name of this element: MultiTexture.
      See Also:
      Constant Field Values

    • COMPONENT

      public static final java.lang.String COMPONENT
      String constant COMPONENT defines X3D component for the MultiTexture element: Texturing
      See Also:
      Constant Field Values

    • LEVEL

      public static final int LEVEL
      Integer 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_VALUE
      SFFloat 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_VALUE
      SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).

    • DESCRIPTION_DEFAULT_VALUE

      public static final java.lang.String DESCRIPTION_DEFAULT_VALUE
      SFString field named description has default value equal to an empty string.
      See Also:
      Constant Field Values

    • FUNCTION_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.String> FUNCTION_DEFAULT_VALUE
      MFString field named function has default value equal to an empty list.

    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject 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_VALUE
      MFString 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_VALUE
      MFString field named source has default value equal to an empty list.

    • containerField_DEFAULT_VALUE

      public static final java.lang.String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values

    • fromField_ALPHA

      public static final java.lang.String fromField_ALPHA
      fromField ROUTE name for SFFloat field named alpha.
      See Also:
      Constant Field Values

    • toField_ALPHA

      public static final java.lang.String toField_ALPHA
      toField ROUTE name for SFFloat field named alpha.
      See Also:
      Constant Field Values

    • fromField_COLOR

      public static final java.lang.String fromField_COLOR
      fromField ROUTE name for SFColor field named color.
      See Also:
      Constant Field Values

    • toField_COLOR

      public static final java.lang.String toField_COLOR
      toField ROUTE name for SFColor field named color.
      See Also:
      Constant Field Values

    • fromField_DESCRIPTION

      public static final java.lang.String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:
      Constant Field Values

    • toField_DESCRIPTION

      public static final java.lang.String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:
      Constant Field Values

    • fromField_FUNCTION

      public static final java.lang.String fromField_FUNCTION
      fromField ROUTE name for MFString field named function.
      See Also:
      Constant Field Values

    • toField_FUNCTION

      public static final java.lang.String toField_FUNCTION
      toField ROUTE name for MFString field named function.
      See Also:
      Constant Field Values

    • fromField_IS

      public static final java.lang.String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
      Constant Field Values

    • fromField_METADATA

      public static final java.lang.String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values

    • toField_METADATA

      public static final java.lang.String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values

    • fromField_MODE

      public static final java.lang.String fromField_MODE
      fromField ROUTE name for MFString field named mode.
      See Also:
      Constant Field Values

    • toField_MODE

      public static final java.lang.String toField_MODE
      toField ROUTE name for MFString field named mode.
      See Also:
      Constant Field Values

    • fromField_SOURCE

      public static final java.lang.String fromField_SOURCE
      fromField ROUTE name for MFString field named source.
      See Also:
      Constant Field Values

    • toField_SOURCE

      public static final java.lang.String toField_SOURCE
      toField ROUTE name for MFString field named source.
      See Also:
      Constant Field Values

    • fromField_TEXTURE

      public static final java.lang.String fromField_TEXTURE
      fromField ROUTE name for MFNode field named texture.
      See Also:
      Constant Field Values

    • toField_TEXTURE

      public static final java.lang.String toField_TEXTURE
      toField ROUTE name for MFNode field named texture.
      See Also:
      Constant Field Values

  • Constructor Details

    • MultiTexture

      public MultiTexture()
      Constructor for MultiTexture to initialize member variables with default values.

    • MultiTexture

      public MultiTexture​(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 class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the MultiTexture element: Texturing
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element

    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 2
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element

    • getFieldType

      public java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

    • getAccessType

      public java.lang.String getAccessType​(java.lang.String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)

    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode

    • 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 interface MultiTexture
      Returns:
      value of alpha field

    • setAlpha

      public MultiTexture setAlpha​(float newValue)
      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 interface MultiTexture
      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

      public MultiTexture setAlpha​(SFFloat newValue)
      Assign typed object value to SFFloat alpha field, similar to setAlpha(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

      public MultiTexture setAlpha​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAlpha(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.
      Specified by:
      getColor in interface MultiTexture
      Returns:
      value of color field

    • setColor

      public MultiTexture setColor​(float[] newValue)
      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.
      Specified by:
      setColor in interface MultiTexture
      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

      public MultiTexture setColor​(SFColor newValue)
      Assign typed object value to SFColor color field, similar to setColor(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

      public MultiTexture setColor​(float red, float green, float blue)
      Assign values to SFColor color field, similar to setColor(float[]).
      Parameters:
      red - first component
      green - second component
      blue - third component
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setColor

      public MultiTexture setColor​(double red, double green, double blue)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(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

      public MultiTexture setColor​(double[] newArray)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(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

      public java.lang.String 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 &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      getDescription in interface MultiTexture
      Specified by:
      getDescription in interface X3DTextureNode
      Returns:
      value of description field

    • setDescription

      public MultiTexture setDescription​(java.lang.String newValue)
      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 &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      setDescription in interface MultiTexture
      Specified by:
      setDescription in interface X3DTextureNode
      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

      public MultiTexture setDescription​(SFString newValue)
      Assign typed object value to SFString description field, similar to setDescription(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

      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.

      Available enumeration values for string comparison: COMPLEMENT, ALPHAREPLICATE, FUNCTION_.
      Specified by:
      getFunction in interface MultiTexture
      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 to getFunction().
      Returns:
      value of function field

    • getFunctionString

      public java.lang.String getFunctionString()
      Utility method to get String value of MFString function field, similar to getFunction().
      Returns:
      value of function field

    • setFunction

      public MultiTexture setFunction​(java.lang.String[] newValue)
      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.
      Specified by:
      setFunction in interface MultiTexture
      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

      public MultiTexture setFunction​(MFString newValue)
      Assign typed object value to MFString function field, similar to setFunction(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

      public MultiTexture setFunction​(SFString newValue)
      Assign single SFString object value to MFString function field, similar to setFunction(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:
      MFString.cleanupEnumerationValues(String)

    • setFunction

      public MultiTexture setFunction​(java.lang.String newValue)
      Assign singleton String value to MFString function field, similar to setFunction(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:
      MFString.cleanupEnumerationValues(String)

    • setFunction

      public MultiTexture setFunction​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString function field, similar to setFunction(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

      public MultiTexture clearFunction()
      Utility method to clear MFString value of function field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addFunction

      public MultiTexture addFunction​(java.lang.String newValue)
      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:
      MFString.cleanupEnumerationValues(String)

    • addFunction

      public MultiTexture addFunction​(SFString newValue)
      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:
      MFString.cleanupEnumerationValues(String)

    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect

    • setIS

      public MultiTexture setIS​(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      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:
      X3D Tooltips: IS, X3D Tooltips: connect

    • clearIS

      public MultiTexture 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:
      getIS()

    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface MultiTexture
      Specified by:
      getMetadata in interface X3DAppearanceChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DTextureNode
      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/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      public MultiTexture setMetadata​(X3DMetadataObject newValue)
      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 interface MultiTexture
      Specified by:
      setMetadata in interface X3DAppearanceChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DTextureNode
      Specified by:
      setMetadata in class X3DConcreteNode
      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:
      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/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • clearMetadata

      public MultiTexture 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

      public MultiTexture setMetadata​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.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.

      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 interface MultiTexture
      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 to getMode().
      Returns:
      value of mode field

    • getModeString

      public java.lang.String getModeString()
      Utility method to get String value of MFString mode field, similar to getMode().
      Returns:
      value of mode field

    • setMode

      public MultiTexture 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.

      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.
      Specified by:
      setMode in interface MultiTexture
      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

      public MultiTexture setMode​(MFString newValue)
      Assign typed object value to MFString mode field, similar to setMode(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

      public MultiTexture setMode​(SFString newValue)
      Assign single SFString object value to MFString mode field, similar to setMode(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:
      MFString.cleanupEnumerationValues(String)

    • setMode

      public MultiTexture setMode​(java.lang.String newValue)
      Assign singleton String value to MFString mode field, similar to setMode(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:
      MFString.cleanupEnumerationValues(String)

    • setMode

      public MultiTexture setMode​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString mode field, similar to setMode(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

      public MultiTexture clearMode()
      Utility method to clear MFString value of mode field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addMode

      public MultiTexture addMode​(java.lang.String newValue)
      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:
      MFString.cleanupEnumerationValues(String)

    • addMode

      public MultiTexture addMode​(SFString newValue)
      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:
      MFString.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.

      Available enumeration values for string comparison: DIFFUSE, FACTOR, SPECULAR, SOURCE_.
      Specified by:
      getSource in interface MultiTexture
      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 to getSource().
      Returns:
      value of source field

    • getSourceString

      public java.lang.String getSourceString()
      Utility method to get String value of MFString source field, similar to getSource().
      Returns:
      value of source field

    • setSource

      public MultiTexture setSource​(java.lang.String[] newValue)
      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.
      Specified by:
      setSource in interface MultiTexture
      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

      public MultiTexture setSource​(MFString newValue)
      Assign typed object value to MFString source field, similar to setSource(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

      public MultiTexture setSource​(SFString newValue)
      Assign single SFString object value to MFString source field, similar to setSource(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:
      MFString.cleanupEnumerationValues(String)

    • setSource

      public MultiTexture setSource​(java.lang.String newValue)
      Assign singleton String value to MFString source field, similar to setSource(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:
      MFString.cleanupEnumerationValues(String)

    • setSource

      public MultiTexture setSource​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString source field, similar to setSource(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

      public MultiTexture clearSource()
      Utility method to clear MFString value of source field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addSource

      public MultiTexture addSource​(java.lang.String newValue)
      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:
      MFString.cleanupEnumerationValues(String)

    • addSource

      public MultiTexture addSource​(SFString newValue)
      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:
      MFString.cleanupEnumerationValues(String)

    • getTexture

      public X3DNode[] 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: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DSingleTextureNode.
      Specified by:
      getTexture in interface MultiTexture
      Returns:
      value of texture field
      See Also:
      X3DSingleTextureNode

    • getTextureList

      public java.util.ArrayList<X3DNode> getTextureList()
      Utility method to get ArrayList value of MFNode texture field, similar to getTexture().
      Returns:
      value of texture field

    • setTexture

      public MultiTexture 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.

      Tooltip: [X3DSingleTextureNode] Contained texture nodes (ImageTexture, MovieTexture, PixelTexture) that map image(s) to surface geometry, defining each of the different texture channels.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DSingleTextureNode.
      Specified by:
      setTexture in interface MultiTexture
      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

      public MultiTexture setTexture​(java.util.ArrayList<X3DSingleTextureNode> newValue)
      Assign ArrayList value of MFNode texture field, similar to setTexture(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

      public MultiTexture addTexture​(X3DNode newValue)
      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

      public MultiTexture addTexture​(ProtoInstance newValue)
      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

      public void addTexture​(X3DNode[] newValue)
      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 interface MultiTexture
      Parameters:
      newValue - is new value array to be appended the texture field.

    • setTexture

      public void setTexture​(X3DNode newValue)
      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 interface MultiTexture
      Parameters:
      newValue - is new node for the texture field (restricted to X3DSingleTextureNode)

    • clearTexture

      public MultiTexture clearTexture()
      Utility method to clear MFNode value of texture field.
      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:
      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.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions

    • setDEF

      public final MultiTexture setDEF​(java.lang.String newValue)
      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.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      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

      public MultiTexture setDEF​(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(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

      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 class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions

    • setUSE

      public final MultiTexture setUSE​(java.lang.String newValue)
      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: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

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

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      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

      public MultiTexture setUSE​(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(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

      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 Cascading Style Sheets (CSS) and XML stylesheets.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets

    • setCssClass

      public final MultiTexture setCssClass​(java.lang.String newValue)
      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 Cascading Style Sheets (CSS) and XML stylesheets.
      Specified by:
      setCssClass in class X3DConcreteNode
      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:
      W3C Cascading Style Sheets

    • setCssClass

      public MultiTexture setCssClass​(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(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).

    • setUSE

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

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

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addComments

      public MultiTexture addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addComments

      public MultiTexture addComments​(java.lang.String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public MultiTexture addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      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

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.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 class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3D.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

    • toStringVRML97

      public java.lang.String toStringVRML97​(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment

    • findElementByNameValue

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

      Warning: first start with 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 class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()

    • 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 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 class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()

    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with 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 class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()

    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
      findNodeByDEF(String)

    • validate

      public java.lang.String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)