Package org.web3d.x3d.jsail.Texturing3D
Class ImageTexture3DObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Texturing3D.ImageTexture3DObject
- All Implemented Interfaces:
X3DNode
,X3DUrlObject
,X3DAppearanceChildNode
,X3DTextureNode
,ImageTexture3D
,X3DTexture3DNode
public class ImageTexture3DObject extends X3DConcreteNode implements ImageTexture3D
ImageTexture3D defines a 3D image-based texture map by specifying a single image file that contains complete 3D data.
X3D node tooltip: (X3D version 3.1 or later) [X3DTexture3DNode,X3DUrlObject] ImageTexture3D defines a 3D image-based texture map by specifying a single image file that contains complete 3D data.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
X3D node tooltip: (X3D version 3.1 or later) [X3DTexture3DNode,X3DUrlObject] ImageTexture3D defines a 3D image-based texture map by specifying a single image file that contains complete 3D data.
- Warning: there are no required file formats, but at least one of the following formats is recommended for volume support in an X3D browser.
- Hint: Microsoft DirectDraw Surface (DDS) https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds
- Hint: Digital Imaging and Communications in Medicine (DICOM) https://www.dicomstandard.org Nevertheless DDS, DICOM, NRRD and/or .vol formats are recommended.
- Hint: Nearly Raw Raster Data (NRRD) http://teem.sourceforge.net/nrrd
- Hint: Volume data format (VOL) http://paulbourke.net/dataformats/volumetric
- Hint: X3D Scene Authoring Hints, Volume Tools and Volumes Visualization https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Volumes
- Hint: can contain a single TextureProperties node.
- Hint: insert Shape and Appearance nodes before adding texture.
- Hint: X3D Architecture 33.2.2 3D texturing concepts https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texture3D.html#3DTextureconcepts
- Hint: apply containerField='watchList' when parent node is LoadSensor.
- Warning: requires X3D profile='Full' or else include <component name='Texturing3D' level='2'/>
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the ImageTexture3D element: Texturing3Dstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.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_URL
fromField ROUTE name for MFString field named url.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Texturing3D component level for this element: 2static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: ImageTexture3D.static boolean
REPEATR_DEFAULT_VALUE
SFBool field named repeatR has default value false (Java syntax) or false (XML syntax).static boolean
REPEATS_DEFAULT_VALUE
SFBool field named repeatS has default value false (Java syntax) or false (XML syntax).static boolean
REPEATT_DEFAULT_VALUE
SFBool field named repeatT has default value false (Java syntax) or false (XML syntax).static TexturePropertiesObject
TEXTUREPROPERTIES_DEFAULT_VALUE
SFNode field named textureProperties has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_URL
toField ROUTE name for MFString field named url.static java.util.ArrayList<java.lang.String>
URL_DEFAULT_VALUE
MFString field named url has default value equal to an empty list.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description ImageTexture3DObject()
Constructor for ImageTexture3DObject to initialize member variables with default values.ImageTexture3DObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description ImageTexture3DObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.ImageTexture3DObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.ImageTexture3DObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.ImageTexture3DObject
addUrl(java.lang.String newValue)
Add singleton String value to MFString url field.ImageTexture3DObject
addUrl(SFStringObject newValue)
Add singleton SFStringObject value to MFString url field.ImageTexture3DObject
clearIS()
Utility method to clear SFNode value of IS field.ImageTexture3DObject
clearMetadata()
Utility method to clear SFNode value of metadata field.ImageTexture3DObject
clearTextureProperties()
Utility method to clear SFNode value of textureProperties field.ImageTexture3DObject
clearUrl()
Utility method to clear MFString value of url field.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.java.lang.String
getComponent()
Defines X3D component for the ImageTexture3D element: Texturing3Dint
getComponentLevel()
Provides default X3D component level for this element: 2java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: ImageTexture3Djava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.boolean
getRepeatR()
Provide boolean value from initializeOnly SFBool field named repeatR.boolean
getRepeatS()
Provide boolean value from initializeOnly SFBool field named repeatS.boolean
getRepeatT()
Provide boolean value from initializeOnly SFBool field named repeatT.TextureProperties
getTextureProperties()
Provide TexturePropertiesObject instance (using a properly typed node) from initializeOnly SFNode field textureProperties.java.lang.String[]
getUrl()
Provide array of String results from inputOutput MFString field named url.java.util.ArrayList<java.lang.String>
getUrlList()
Utility method to get ArrayList value of MFString url field, similar togetUrl()
.java.lang.String
getUrlString()
Utility method to get String value of MFString url field, similar togetUrl()
.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
hasTextureProperties()
Indicate whether an object is available for initializeOnly SFNode field textureProperties.void
initialize()
Initialize all member variables to default values.ImageTexture3DObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.ImageTexture3DObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.ImageTexture3DObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.ImageTexture3DObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.ImageTexture3DObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.ImageTexture3DObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.ImageTexture3DObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.ImageTexture3DObject
setRepeatR(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named repeatR.ImageTexture3DObject
setRepeatR(SFBoolObject newValue)
Assign typed object value to SFBool repeatR field, similar tosetRepeatR(boolean)
.ImageTexture3DObject
setRepeatS(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.ImageTexture3DObject
setRepeatS(SFBoolObject newValue)
Assign typed object value to SFBool repeatS field, similar tosetRepeatS(boolean)
.ImageTexture3DObject
setRepeatT(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.ImageTexture3DObject
setRepeatT(SFBoolObject newValue)
Assign typed object value to SFBool repeatT field, similar tosetRepeatT(boolean)
.ImageTexture3DObject
setTextureProperties(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field textureProperties.ImageTexture3DObject
setTextureProperties(TextureProperties newValue)
Accessor method to assign TexturePropertiesObject instance (using a properly typed node) to initializeOnly SFNode field textureProperties.ImageTexture3DObject
setUrl(java.lang.String newValue)
Assign singleton String value to MFString url field, similar tosetUrl(String[])
.ImageTexture3DObject
setUrl(java.lang.String[] newValue)
Accessor method to assign String array to inputOutput MFString field named url.ImageTexture3DObject
setUrl(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString url field, similar tosetUrl(String[])
.ImageTexture3DObject
setUrl(MFStringObject newValue)
Assign typed object value to MFString url field, similar tosetUrl(String[])
.ImageTexture3DObject
setUrl(SFStringObject newValue)
Assign single SFString object value to MFString url field, similar tosetUrl(String[])
.ImageTexture3DObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.ImageTexture3DObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.ImageTexture3DObject
setUSE(ImageTexture3DObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.String
validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: ImageTexture3D.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the ImageTexture3D element: Texturing3D- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Texturing3D component level for this element: 2- See Also:
- Constant Field Values
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
REPEATR_DEFAULT_VALUE
public static final boolean REPEATR_DEFAULT_VALUESFBool field named repeatR has default value false (Java syntax) or false (XML syntax).- See Also:
- Constant Field Values
-
REPEATS_DEFAULT_VALUE
public static final boolean REPEATS_DEFAULT_VALUESFBool field named repeatS has default value false (Java syntax) or false (XML syntax).- See Also:
- Constant Field Values
-
REPEATT_DEFAULT_VALUE
public static final boolean REPEATT_DEFAULT_VALUESFBool field named repeatT has default value false (Java syntax) or false (XML syntax).- See Also:
- Constant Field Values
-
TEXTUREPROPERTIES_DEFAULT_VALUE
SFNode field named textureProperties has default value null (Java syntax) or NULL (XML syntax). -
URL_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.String> URL_DEFAULT_VALUEMFString field named url has default value equal to an empty list. -
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_URL
public static final java.lang.String fromField_URLfromField ROUTE name for MFString field named url.- See Also:
- Constant Field Values
-
toField_URL
public static final java.lang.String toField_URLtoField ROUTE name for MFString field named url.- See Also:
- Constant Field Values
-
-
Constructor Details
-
ImageTexture3DObject
public ImageTexture3DObject()Constructor for ImageTexture3DObject to initialize member variables with default values. -
ImageTexture3DObject
public ImageTexture3DObject(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: ImageTexture3D- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the ImageTexture3D element: Texturing3D- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasIS
public boolean hasIS()Indicate whether an object is available for inputOutput SFNode field IS.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
getIS()
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceImageTexture3D
- Specified by:
getMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DTexture3DNode
- Specified by:
getMetadata
in interfaceX3DTextureNode
- Returns:
- value of metadata field
- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceImageTexture3D
- Specified by:
setMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DTexture3DNode
- Specified by:
setMetadata
in interfaceX3DTextureNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(X3DMetadataObject)
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getMetadata()
,getMetadataProtoInstance()
, X3D Scene Authoring Hints: Metadata Nodes
-
getRepeatR
public boolean getRepeatR()Provide boolean value from initializeOnly SFBool field named repeatR.
Tooltip: Whether to vertically repeat texture along R axis. *- Specified by:
getRepeatR
in interfaceImageTexture3D
- Specified by:
getRepeatR
in interfaceX3DTexture3DNode
- Returns:
- value of repeatR field
-
setRepeatR
Accessor method to assign boolean value to initializeOnly SFBool field named repeatR.
Tooltip: Whether to vertically repeat texture along R axis. *- Specified by:
setRepeatR
in interfaceImageTexture3D
- Specified by:
setRepeatR
in interfaceX3DTexture3DNode
- Parameters:
newValue
- is new value for the repeatR field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRepeatR
Assign typed object value to SFBool repeatR field, similar tosetRepeatR(boolean)
.- Parameters:
newValue
- is new value for the repeatR field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRepeatS
public boolean getRepeatS()Provide boolean value from initializeOnly SFBool field named repeatS.
Tooltip: Whether to horizontally repeat texture along S axis. *- Specified by:
getRepeatS
in interfaceImageTexture3D
- Specified by:
getRepeatS
in interfaceX3DTexture3DNode
- Returns:
- value of repeatS field
-
setRepeatS
Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.
Tooltip: Whether to horizontally repeat texture along S axis. *- Specified by:
setRepeatS
in interfaceImageTexture3D
- Specified by:
setRepeatS
in interfaceX3DTexture3DNode
- Parameters:
newValue
- is new value for the repeatS field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRepeatS
Assign typed object value to SFBool repeatS field, similar tosetRepeatS(boolean)
.- Parameters:
newValue
- is new value for the repeatS field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRepeatT
public boolean getRepeatT()Provide boolean value from initializeOnly SFBool field named repeatT.
Tooltip: Whether to vertically repeat texture along T axis. *- Specified by:
getRepeatT
in interfaceImageTexture3D
- Specified by:
getRepeatT
in interfaceX3DTexture3DNode
- Returns:
- value of repeatT field
-
setRepeatT
Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.
Tooltip: Whether to vertically repeat texture along T axis. *- Specified by:
setRepeatT
in interfaceImageTexture3D
- Specified by:
setRepeatT
in interfaceX3DTexture3DNode
- Parameters:
newValue
- is new value for the repeatT field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRepeatT
Assign typed object value to SFBool repeatT field, similar tosetRepeatT(boolean)
.- Parameters:
newValue
- is new value for the repeatT field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTextureProperties
Provide TexturePropertiesObject instance (using a properly typed node) from initializeOnly SFNode field textureProperties.- Specified by:
getTextureProperties
in interfaceImageTexture3D
- Specified by:
getTextureProperties
in interfaceX3DTexture3DNode
- Returns:
- value of textureProperties field
- See Also:
getTexturePropertiesProtoInstance()
-
setTextureProperties
Accessor method to assign TexturePropertiesObject instance (using a properly typed node) to initializeOnly SFNode field textureProperties.- Specified by:
setTextureProperties
in interfaceImageTexture3D
- Specified by:
setTextureProperties
in interfaceX3DTexture3DNode
- Parameters:
newValue
- is new value for the textureProperties field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setTextureProperties(ProtoInstanceObject)
-
clearTextureProperties
Utility method to clear SFNode value of textureProperties field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setTextureProperties
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field textureProperties.- Parameters:
newValue
- is new value for the textureProperties field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setTextureProperties(TextureProperties)
-
hasTextureProperties
public boolean hasTextureProperties()Indicate whether an object is available for initializeOnly SFNode field textureProperties.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getTextureProperties()
,getTexturePropertiesProtoInstance()
-
getUrl
public java.lang.String[] getUrl()Provide array of String results from inputOutput MFString field named url.
Tooltip: Location and filename of image. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.- Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
- Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
- Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
- Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
- Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
- Specified by:
getUrl
in interfaceImageTexture3D
- Specified by:
getUrl
in interfaceX3DUrlObject
- Returns:
- value of url field
-
getUrlList
public java.util.ArrayList<java.lang.String> getUrlList()Utility method to get ArrayList value of MFString url field, similar togetUrl()
.- Returns:
- value of url field
-
getUrlString
public java.lang.String getUrlString()Utility method to get String value of MFString url field, similar togetUrl()
.- Returns:
- value of url field
-
setUrl
Accessor method to assign String array to inputOutput MFString field named url.
Tooltip: Location and filename of image. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.- Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
- Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
- Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
- Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
- Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
- Specified by:
setUrl
in interfaceImageTexture3D
- Specified by:
setUrl
in interfaceX3DUrlObject
- Parameters:
newValue
- is new value for the url field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUrl
Assign typed object value to MFString url field, similar tosetUrl(String[])
.- Parameters:
newValue
- is new value for the url field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUrl
Assign single SFString object value to MFString url field, similar tosetUrl(String[])
.- Parameters:
newValue
- is new value for the url field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUrl
Assign singleton String value to MFString url field, similar tosetUrl(String[])
.- Parameters:
newValue
- is new value for the url field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUrl
Assign ArrayList value of MFString url field, similar tosetUrl(String[])
.- Parameters:
newValue
- is new value for the url field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearUrl
Utility method to clear MFString value of url field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addUrl
Add singleton String value to MFString url field.- Parameters:
newValue
- is new value to add to the url field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addUrl
Add singleton SFStringObject value to MFString url field.- Parameters:
newValue
- is new value to add to the url field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
getDEF
public java.lang.String getDEF()Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.String getUSE()Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Parameters:
DEFnode
- must have a DEF value defined- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
ImageTexture3DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.String toStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.FILE_EXTENSION_CLASSICVRML
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
-
toStringVRML97
public java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
findElementByNameValue(String, String)
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
findNodeByDEF(String)
-
validate
public java.lang.String validate()Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-