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

public class PixelTexture
extends X3DConcreteNode
implements PixelTexture

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 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:

• X3D Abstract Specification: PixelTexture
• X3D Tooltips: PixelTexture
• X3D Scene Authoring Hints: Images

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the PixelTexture element: Texturing
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_IMAGE	fromField ROUTE name for SFImage field named image.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final ArrayList<Integer>	IMAGE_DEFAULT_VALUE	SFImage field named image has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Texturing component level for this element: 1
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: PixelTexture.
static final boolean	REPEATS_DEFAULT_VALUE	SFBool field named repeatS has default value true (Java syntax) or true (XML syntax).
static final boolean	REPEATT_DEFAULT_VALUE	SFBool field named repeatT has default value true (Java syntax) or true (XML syntax).
static final TextureProperties	TEXTUREPROPERTIES_DEFAULT_VALUE	SFNode field named textureProperties has default value null (Java syntax) or NULL (XML syntax).
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_IMAGE	toField ROUTE name for SFImage field named image.
static final String	toField_METADATA	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

Constructors

Constructor	Description
PixelTexture()	Constructor 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 Type	Method	Description
PixelTexture	addComments(String newComment)	Add comment as String to contained commentsList.
PixelTexture	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
PixelTexture	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
PixelTexture	clearImage()	Utility method to clear SFImage value of image field.
PixelTexture	clearIS()	Utility method to clear SFNode value of IS field.
PixelTexture	clearMetadata()	Utility method to clear SFNode value of metadata field.
PixelTexture	clearTextureProperties()	Utility method to clear SFNode value of textureProperties field.
X3DConcreteElement	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.
X3DConcreteElement	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.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
final String	getComponent()	Defines X3D component for the PixelTexture element: Texturing
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
String	getDescription()	Provide String value from inputOutput SFString field named description.
final String	getElementName()	Provides name of this element: PixelTexture
int	getExpectedLength()	Compute expected length of integer array based on width and height values.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
int	getHeight()	Utility method to determine height of texture from second element in value array.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
int[]	getImage()	Provide array of Integer results from inputOutput SFImage field named image.
ArrayList<Integer>	getImageList()	Utility method to get ArrayList value of SFImage image field, similar to getImage().
String	getImageString()	Utility method to get String value of SFImage image field, similar to getImage().
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.
int	getNumberComponents()	Utility method to determine number of components of texture (1..4 components) from third element in value array.
int[]	getPixels()	Utility method to provide pixels (following parameters) in value array.
String	getPixelsString()	Utility method to get String value of SFImage image field only, without size parameters.
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 org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
String	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	hasMetadata()	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	hasTextureProperties()	Indicate whether an object is available for initializeOnly SFNode field textureProperties.
final void	initialize()	Initialize all member variables to default values.
final PixelTexture	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
PixelTexture	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final PixelTexture	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
PixelTexture	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final PixelTexture	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
PixelTexture	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
PixelTexture	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
PixelTexture	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
final PixelTexture	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
PixelTexture	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
PixelTexture	setImage(int[] newValue)	Accessor method to assign Integer array to inputOutput SFImage field named image.
PixelTexture	setImage(ArrayList<Integer> newValue)	Assign ArrayList value of SFImage image field, similar to setImage(int[]).
PixelTexture	setImage(SFImage newValue)	Assign typed object value to SFImage image field, similar to setImage(int[]).
PixelTexture	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
PixelTexture	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
PixelTexture	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
PixelTexture	setRepeatS(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.
PixelTexture	setRepeatS(SFBool newValue)	Assign typed object value to SFBool repeatS field, similar to setRepeatS(boolean).
PixelTexture	setRepeatT(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.
PixelTexture	setRepeatT(SFBool newValue)	Assign typed object value to SFBool repeatT field, similar to setRepeatT(boolean).
PixelTexture	setTextureProperties(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field textureProperties.
PixelTexture	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	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
PixelTexture	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
PixelTexture	setUSE(PixelTexture DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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

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

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: PixelTexture.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the PixelTexture 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: 1

See Also:

• Constant Field Values

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

See Also:

• Constant Field Values

IMAGE_DEFAULT_VALUE

public static final ArrayList<Integer> IMAGE_DEFAULT_VALUE

SFImage field named image has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).

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).

REPEATS_DEFAULT_VALUE

public static final boolean REPEATS_DEFAULT_VALUE

SFBool field named repeatS has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

REPEATT_DEFAULT_VALUE

public static final boolean REPEATT_DEFAULT_VALUE

SFBool field named repeatT has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

TEXTUREPROPERTIES_DEFAULT_VALUE

public static final TextureProperties TEXTUREPROPERTIES_DEFAULT_VALUE

SFNode field named textureProperties has default value null (Java syntax) or NULL (XML syntax).

containerField_DEFAULT_VALUE

public static final String 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:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

fromField_IMAGE

public static final String fromField_IMAGE

fromField ROUTE name for SFImage field named image.

See Also:

• Constant Field Values

toField_IMAGE

public static final String toField_IMAGE

toField ROUTE name for SFImage field named image.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

Constructor Details

PixelTexture

public PixelTexture()

Constructor for PixelTexture to initialize member variables with default values.

PixelTexture

public PixelTexture(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 String getElementName()

Provides name of this element: PixelTexture

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the PixelTexture 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: 1

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(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 String getAccessType(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 String 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 class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getDescription

public 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 & for & ampersand character, or " for " quotation-mark character).

Specified by:

getDescription in interface PixelTexture

Specified by:

getDescription in interface X3DSingleTextureNode

Specified by:

getDescription in interface X3DTexture2DNode

Specified by:

getDescription in interface X3DTextureNode

Returns:

value of description field

setDescription

public PixelTexture setDescription(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 & for & ampersand character, or " for " quotation-mark character).

Specified by:

setDescription in interface PixelTexture

Specified by:

setDescription in interface X3DSingleTextureNode

Specified by:

setDescription in interface X3DTexture2DNode

Specified by:

setDescription in interface X3DTextureNode

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

public PixelTexture 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:

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 interface PixelTexture

Returns:

value of image field

getImageList

public ArrayList<Integer> getImageList()

Utility method to get ArrayList value of SFImage image field, similar to getImage().

Returns:

value of image field

getImageString

public String getImageString()

Utility method to get String value of SFImage image field, similar to getImage().

Returns:

value of image field

setImage

public PixelTexture setImage(int[] newValue)

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 interface PixelTexture

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

public PixelTexture setImage(SFImage newValue)

Assign typed object value to SFImage image field, similar to setImage(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

public PixelTexture setImage(ArrayList<Integer> newValue)

Assign ArrayList value of SFImage image field, similar to setImage(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

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

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 PixelTexture 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:

PixelTexture - 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 PixelTexture 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:

• 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 PixelTexture

Specified by:

getMetadata in interface X3DAppearanceChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DSingleTextureNode

Specified by:

getMetadata in interface X3DTexture2DNode

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/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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

Specified by:

setMetadata in interface X3DAppearanceChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DSingleTextureNode

Specified by:

setMetadata in interface X3DTexture2DNode

Specified by:

setMetadata in interface X3DTextureNode

Specified by:

setMetadata in class X3DConcreteNode

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:

• 
  
  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/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

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

public PixelTexture 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:

PixelTexture - 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

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 interface PixelTexture

Specified by:

getRepeatS in interface X3DTexture2DNode

Returns:

value of repeatS field

setRepeatS

public PixelTexture setRepeatS(boolean newValue)

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 interface PixelTexture

Specified by:

setRepeatS in interface X3DTexture2DNode

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

public PixelTexture setRepeatS(SFBool newValue)

Assign typed object value to SFBool repeatS field, similar to setRepeatS(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 interface PixelTexture

Specified by:

getRepeatT in interface X3DTexture2DNode

Returns:

value of repeatT field

setRepeatT

public PixelTexture setRepeatT(boolean newValue)

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 interface PixelTexture

Specified by:

setRepeatT in interface X3DTexture2DNode

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

public PixelTexture setRepeatT(SFBool newValue)

Assign typed object value to SFBool repeatT field, similar to setRepeatT(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

public TextureProperties getTextureProperties()

Provide org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.

Specified by:

getTextureProperties in interface PixelTexture

Specified by:

getTextureProperties in interface X3DTexture2DNode

Returns:

value of textureProperties field

See Also:

• 
  
  Tooltip: [TextureProperties] Single contained TextureProperties node that can specify additional visual attributes applied to corresponding texture images. *
  

setTextureProperties

public PixelTexture setTextureProperties(TextureProperties newValue)

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 interface PixelTexture

Specified by:

setTextureProperties in interface X3DTexture2DNode

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:

• 
  
  Tooltip: [TextureProperties] Single contained TextureProperties node that can specify additional visual attributes applied to corresponding texture images. *
  

clearTextureProperties

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

public PixelTexture setTextureProperties(ProtoInstance newValue)

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:

• setTextureProperties(org.web3d.x3d.sai.Texturing.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()

getDEF

public 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 class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final PixelTexture setDEF(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.

• 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 class X3DConcreteNode

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

public PixelTexture 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:

PixelTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public 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 PixelTexture setUSE(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:

PixelTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public PixelTexture 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:

PixelTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final PixelTexture setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

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:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public PixelTexture 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:

PixelTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final PixelTexture setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

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:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public PixelTexture setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(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

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final PixelTexture setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

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:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public PixelTexture setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(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

public PixelTexture setUSE(PixelTexture 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:

PixelTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public PixelTexture addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

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:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public PixelTexture addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

PixelTexture - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public PixelTexture addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

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

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

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(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(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 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. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

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()
• getHeight()

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

public String getPixelsString()

Utility method to get String value of SFImage image field only, without size parameters.

Returns:

string value of pixels (only, no size parameters)