Package org.web3d.x3d.jsail.Texturing
Class PixelTexture
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Texturing.PixelTexture
- All Implemented Interfaces:
X3DNode
,X3DAppearanceChildNode
,PixelTexture
,X3DSingleTextureNode
,X3DTexture2DNode
,X3DTextureNode
PixelTexture creates a 2D-image texture map using a numeric array of pixel values.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
PixelTexture node tooltip: [X3DTexture2DNode] PixelTexture creates a 2D-image texture map using a numeric array of pixel values. Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s, t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.
- Hint: this is a good way to bundle image(s) into a single scene file, avoiding multiple downloads.
- Hint: X3D-Edit includes PixelTexture image-conversion import capabilities. https://savage.nps.edu/X3D-Edit/images/PixelTextureImportImage.png
- Warning: aggregate file size can grow dramatically.
- Hint: can contain a single TextureProperties node.
- Hint: insert Shape and Appearance nodes before adding texture.
- Hint: X3D Scene Authoring Hints, Images and Videos https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
- Warning: see ComposedCubeMapTexture and TextureBackground for special containerField values.
- Hint: if a texture is opaque, omitting values in the alpha channel can help avoid rendering artifacts related to transparency.
- Hint: Texture coordinates are reapplied (or else recomputed if textureTransform field initially NULL) whenever the corresponding vertex-based geometry changes.
- Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
- Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/lighting.html#Lightingmodel
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
String constant COMPONENT defines X3D component for the PixelTexture element: Texturingstatic final String
containerField describes typical field relationship of a node to its parent.static final String
SFString field named description has default value equal to an empty string.static final String
fromField ROUTE name for SFString field named description.static final String
fromField ROUTE name for SFImage field named image.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFNode field named metadata.SFImage field named image has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final int
Integer constant LEVEL provides default X3D Texturing component level for this element: 1static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: PixelTexture.static final boolean
SFBool field named repeatS has default value true (Java syntax) or true (XML syntax).static final boolean
SFBool field named repeatT has default value true (Java syntax) or true (XML syntax).static final TextureProperties
SFNode field named textureProperties has default value null (Java syntax) or NULL (XML syntax).static final String
toField ROUTE name for SFString field named description.static final String
toField ROUTE name for SFImage field named image.static final String
toField ROUTE name for SFNode field named metadata.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
ConstructorDescriptionConstructor for PixelTexture to initialize member variables with default values.PixelTexture
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.Utility method to clear SFImage value of image field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear SFNode value of metadata field.Utility method to clear SFNode value of textureProperties field.findElementByNameValue
(String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findElementByNameValue
(String nameValue, String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.final String
Defines X3D component for the PixelTexture element: Texturingfinal int
Provides default X3D component level for this element: 1final String
containerField describes typical field relationship of a node to its parent.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.Provide String value from inputOutput SFString field named description.final String
Provides name of this element: PixelTextureint
Compute expected length of integer array based on width and height values.getFieldType
(String fieldName) Indicate type corresponding to given fieldName.int
Utility method to determine height of texture from second element in value array.Provide String value from inputOutput SFString field named id.int[]
getImage()
Provide array of Integer results from inputOutput SFImage field named image.Utility method to get ArrayList value of SFImage image field, similar togetImage()
.Utility method to get String value of SFImage image field, similar togetImage()
.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.int
Utility method to determine number of components of texture (1..4 components) from third element in value array.int[]
Utility method to provide pixels (following parameters) in value array.Utility method to get String value of SFImage image field only, without size parameters.boolean
Provide boolean value from initializeOnly SFBool field named repeatS.boolean
Provide boolean value from initializeOnly SFBool field named repeatT.Provide org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.getUSE()
Provide String value from inputOutput SFString field named USE.int
getWidth()
Utility method to determine width of texture from initial element in value array.boolean
hasElementByNameValue
(String nameValue, String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.boolean
Indicate whether an object is available for initializeOnly SFNode field textureProperties.final void
Initialize all member variables to default values.final PixelTexture
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final PixelTexture
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final PixelTexture
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.setDescription
(String newValue) Accessor method to assign String value to inputOutput SFString field named description.setDescription
(SFString newValue) Assign typed object value to SFString description field, similar tosetDescription(String)
.final PixelTexture
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.setImage
(int[] newValue) Accessor method to assign Integer array to inputOutput SFImage field named image.Assign ArrayList value of SFImage image field, similar tosetImage(int[])
.Assign typed object value to SFImage image field, similar tosetImage(int[])
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setRepeatS
(boolean newValue) Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.setRepeatS
(SFBool newValue) Assign typed object value to SFBool repeatS field, similar tosetRepeatS(boolean)
.setRepeatT
(boolean newValue) Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.setRepeatT
(SFBool newValue) Assign typed object value to SFBool repeatT field, similar tosetRepeatT(boolean)
.setTextureProperties
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field textureProperties.setTextureProperties
(TextureProperties newValue) Accessor method to assign org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.final PixelTexture
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(PixelTexture DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
String constant NAME provides name of this element: PixelTexture.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the PixelTexture element: Texturing- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Texturing component level for this element: 1- See Also:
-
DESCRIPTION_DEFAULT_VALUE
SFString field named description has default value equal to an empty string.- See Also:
-
IMAGE_DEFAULT_VALUE
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
REPEATS_DEFAULT_VALUE
public static final boolean REPEATS_DEFAULT_VALUESFBool field named repeatS has default value true (Java syntax) or true (XML syntax).- See Also:
-
REPEATT_DEFAULT_VALUE
public static final boolean REPEATT_DEFAULT_VALUESFBool field named repeatT has default value true (Java syntax) or true (XML syntax).- See Also:
-
TEXTUREPROPERTIES_DEFAULT_VALUE
SFNode field named textureProperties has default value null (Java syntax) or NULL (XML syntax). -
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "texture";
containerField_ALLOWED_VALUES = {"texture", "back", "bottom", "front", "left", "right", "top", "backTexture", "bottomTexture", "frontTexture", "leftTexture", "rightTexture", "topTexture" }; type X3DUOM containerFieldChoicesX3DTexture2DNode- See Also:
-
fromField_DESCRIPTION
fromField ROUTE name for SFString field named description.- See Also:
-
toField_DESCRIPTION
toField ROUTE name for SFString field named description.- See Also:
-
fromField_IMAGE
fromField ROUTE name for SFImage field named image.- See Also:
-
toField_IMAGE
toField ROUTE name for SFImage field named image.- See Also:
-
fromField_IS
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
-
Constructor Details
-
PixelTexture
public PixelTexture()Constructor for PixelTexture to initialize member variables with default values. -
PixelTexture
Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
Provides name of this element: PixelTexture- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the PixelTexture element: Texturing- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getDescription
Provide String value from inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose of the url asset.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
getDescription
in interfacePixelTexture
- Specified by:
getDescription
in interfaceX3DSingleTextureNode
- Specified by:
getDescription
in interfaceX3DTexture2DNode
- Specified by:
getDescription
in interfaceX3DTextureNode
- Returns:
- value of description field
-
setDescription
Accessor method to assign String value to inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose of the url asset.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
setDescription
in interfacePixelTexture
- Specified by:
setDescription
in interfaceX3DSingleTextureNode
- Specified by:
setDescription
in interfaceX3DTexture2DNode
- Specified by:
setDescription
in interfaceX3DTextureNode
- Parameters:
newValue
- is new value for the description field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDescription
Assign typed object value to SFString description field, similar tosetDescription(String)
.- Parameters:
newValue
- is new value for the description field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getImage
public int[] getImage()Provide array of Integer results from inputOutput SFImage field named image.
Tooltip: Defines image: width, height, number_of_components per each pixel value, and list of pixel_values. Note that width and height are pixel count, and allowed values for RGBA number_of_components in each pixel value are 1 (intensity), 2 (intensity alpha), 3 (red green blue), 4 (red green blue alpha-opacity).- Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are different. Example: intensity [1 2 1 0xFF 0x00] Example: intensity-alpha [2 2 1 0 255 255 0] Example: red-green-blue [2 4 3 0xFF0000 0xFF00 0 0 0 0 0xFFFFFF 0xFFFF00] Example: red-green-blue-alpha [2 2 4 0xFFFFFFAA 0xFFFF00AA 0x11111111AA 0x787800AA]
- Hint: it is easier to understand hexadecimal values for each pixel, but integer values are also allowed.
- Hint: the array of pixel values has length = (width*height).
- Hint: the full list of integers in this field has length = (width*height + 3).
- Specified by:
getImage
in interfacePixelTexture
- Returns:
- value of image field
-
getImageList
Utility method to get ArrayList value of SFImage image field, similar togetImage()
.- Returns:
- value of image field
-
getImageString
Utility method to get String value of SFImage image field, similar togetImage()
.- Returns:
- value of image field
-
setImage
Accessor method to assign Integer array to inputOutput SFImage field named image.
Tooltip: Defines image: width, height, number_of_components per each pixel value, and list of pixel_values. Note that width and height are pixel count, and allowed values for RGBA number_of_components in each pixel value are 1 (intensity), 2 (intensity alpha), 3 (red green blue), 4 (red green blue alpha-opacity).- Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are different. Example: intensity [1 2 1 0xFF 0x00] Example: intensity-alpha [2 2 1 0 255 255 0] Example: red-green-blue [2 4 3 0xFF0000 0xFF00 0 0 0 0 0xFFFFFF 0xFFFF00] Example: red-green-blue-alpha [2 2 4 0xFFFFFFAA 0xFFFF00AA 0x11111111AA 0x787800AA]
- Hint: it is easier to understand hexadecimal values for each pixel, but integer values are also allowed.
- Hint: the array of pixel values has length = (width*height).
- Hint: the full list of integers in this field has length = (width*height + 3).
- Specified by:
setImage
in interfacePixelTexture
- Parameters:
newValue
- is new value for the image field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setImage
Assign typed object value to SFImage image field, similar tosetImage(int[])
.- Parameters:
newValue
- is new value for the image field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setImage
Assign ArrayList value of SFImage image field, similar tosetImage(int[])
.- Parameters:
newValue
- is new value for the image field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearImage
Utility method to clear SFImage value of image field. This method does not initialize withIMAGE_DEFAULT_VALUE.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasIS
public boolean hasIS()Indicate whether an object is available for inputOutput SFNode field IS.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfacePixelTexture
- Specified by:
getMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DSingleTextureNode
- Specified by:
getMetadata
in interfaceX3DTexture2DNode
- Specified by:
getMetadata
in interfaceX3DTextureNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfacePixelTexture
- Specified by:
setMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DSingleTextureNode
- Specified by:
setMetadata
in interfaceX3DTexture2DNode
- Specified by:
setMetadata
in interfaceX3DTextureNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
PixelTexture
- 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:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
getRepeatS
public boolean getRepeatS()Provide boolean value from initializeOnly SFBool field named repeatS.
Tooltip: Whether to repeat texture along S axis horizontally from left to right. *- Specified by:
getRepeatS
in interfacePixelTexture
- Specified by:
getRepeatS
in interfaceX3DTexture2DNode
- Returns:
- value of repeatS field
-
setRepeatS
Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.
Tooltip: Whether to repeat texture along S axis horizontally from left to right. *- Specified by:
setRepeatS
in interfacePixelTexture
- Specified by:
setRepeatS
in interfaceX3DTexture2DNode
- Parameters:
newValue
- is new value for the repeatS field.- Returns:
PixelTexture
- 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:
PixelTexture
- 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 repeat texture along T axis vertically from top to bottom. *- Specified by:
getRepeatT
in interfacePixelTexture
- Specified by:
getRepeatT
in interfaceX3DTexture2DNode
- Returns:
- value of repeatT field
-
setRepeatT
Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.
Tooltip: Whether to repeat texture along T axis vertically from top to bottom. *- Specified by:
setRepeatT
in interfacePixelTexture
- Specified by:
setRepeatT
in interfaceX3DTexture2DNode
- Parameters:
newValue
- is new value for the repeatT field.- Returns:
PixelTexture
- 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:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTextureProperties
Provide org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.- Specified by:
getTextureProperties
in interfacePixelTexture
- Specified by:
getTextureProperties
in interfaceX3DTexture2DNode
- Returns:
- value of textureProperties field
- See Also:
-
setTextureProperties
Accessor method to assign org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.- Specified by:
setTextureProperties
in interfacePixelTexture
- Specified by:
setTextureProperties
in interfaceX3DTexture2DNode
- Parameters:
newValue
- is new value for the textureProperties field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearTextureProperties
Utility method to clear SFNode value of textureProperties field.- Returns:
PixelTexture
- 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:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getDEF
Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
PixelTexture
- 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:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
PixelTexture
- 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:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
PixelTexture
- 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:
PixelTexture
- 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:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
PixelTexture
- 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:
PixelTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
-
hasElementByNameValue
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
-
hasNodeByDEF
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
-
validate
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-
getExpectedLength
public int getExpectedLength()Compute expected length of integer array based on width and height values. Note that each integer pixel value must represent the full set of components for this SFImage.- Returns:
- number of pixel values expected in image integer array
- See Also:
-
getWidth
public int getWidth()Utility method to determine width of texture from initial element in value array.- Returns:
- width parameter of value field
-
getHeight
public int getHeight()Utility method to determine height of texture from second element in value array.- Returns:
- height parameter of value field
-
getNumberComponents
public int getNumberComponents()Utility method to determine number of components of texture (1..4 components) from third element in value array.- Returns:
- number of components for each element in value field
-
getPixels
public int[] getPixels()Utility method to provide pixels (following parameters) in value array.- Returns:
- pixels in image field
-
getPixelsString
Utility method to get String value of SFImage image field only, without size parameters.- Returns:
- string value of pixels (only, no size parameters)
-