Class TextureProjector

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.TextureProjection.TextureProjector

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DLightNode, TextureProjector, X3DTextureProjectorNode

public class TextureProjector
extends X3DConcreteNode
implements TextureProjector

TextureProjector is similar to a light that projects a texture into the scene, illuminating geometry that intersects the perspective projection volume.

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. TextureProjector node tooltip: [X3DTextureProjectorNode] TextureProjector is similar to a light that projects a texture into the scene, illuminating geometry that intersects the perspective projection volume.

• Hint: specification errata corrections at https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4.1-CD/Part01/components/textureProjection.html#TextureProjector
• Hint: diagram https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4.1-CD/Images/ptmperspective2.png

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: TextureProjector
• X3D Tooltips: TextureProjector
• X3D Scene Authoring Hints: Images

Field Summary

Fields

Modifier and Type	Field	Description
static final float	AMBIENTINTENSITY_DEFAULT_VALUE	SFFloat field named ambientIntensity has default value 0f (Java syntax) or 0 (XML syntax).
static final float[]	COLOR_DEFAULT_VALUE	SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the TextureProjector element: TextureProjection
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 float[]	DIRECTION_DEFAULT_VALUE	SFVec3f field named direction has default value {0f,0f,1f} (Java syntax) or 0 0 1 (XML syntax).
static final float	FARDISTANCE_DEFAULT_VALUE	SFFloat field named farDistance has default value -1f (Java syntax) or -1 (XML syntax).
static final float	FIELDOFVIEW_DEFAULT_VALUE	SFFloat field named fieldOfView has default value 0.7854f (Java syntax) or 0.7854 (XML syntax).
static final String	fromField_AMBIENTINTENSITY	fromField ROUTE name for SFFloat field named ambientIntensity.
static final String	fromField_ASPECTRATIO	fromField ROUTE name for SFFloat field named aspectRatio.
static final String	fromField_COLOR	fromField ROUTE name for SFColor field named color.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_DIRECTION	fromField ROUTE name for SFVec3f field named direction.
static final String	fromField_FARDISTANCE	fromField ROUTE name for SFFloat field named farDistance.
static final String	fromField_FIELDOFVIEW	fromField ROUTE name for SFFloat field named fieldOfView.
static final String	fromField_GLOBAL	fromField ROUTE name for SFBool field named global.
static final String	fromField_INTENSITY	fromField ROUTE name for SFFloat field named intensity.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_LOCATION	fromField ROUTE name for SFVec3f field named location.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_NEARDISTANCE	fromField ROUTE name for SFFloat field named nearDistance.
static final String	fromField_ON	fromField ROUTE name for SFBool field named on.
static final String	fromField_SHADOWINTENSITY	fromField ROUTE name for SFFloat field named shadowIntensity.
static final String	fromField_SHADOWS	fromField ROUTE name for SFBool field named shadows.
static final String	fromField_TEXTURE	fromField ROUTE name for SFNode field named texture.
static final String	fromField_UPVECTOR	fromField ROUTE name for SFVec3f field named upVector.
static final boolean	GLOBAL_DEFAULT_VALUE	SFBool field named global has default value true (Java syntax) or true (XML syntax).
static final float	INTENSITY_DEFAULT_VALUE	SFFloat field named intensity has default value 1f (Java syntax) or 1 (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 TextureProjection component level for this element: 2
static final float[]	LOCATION_DEFAULT_VALUE	SFVec3f field named location has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
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: TextureProjector.
static final float	NEARDISTANCE_DEFAULT_VALUE	SFFloat field named nearDistance has default value -1f (Java syntax) or -1 (XML syntax).
static final boolean	ON_DEFAULT_VALUE	SFBool field named on has default value true (Java syntax) or true (XML syntax).
static final float	SHADOWINTENSITY_DEFAULT_VALUE	SFFloat field named shadowIntensity has default value 1f (Java syntax) or 1 (XML syntax).
static final boolean	SHADOWS_DEFAULT_VALUE	SFBool field named shadows has default value false (Java syntax) or false (XML syntax).
static final X3DTexture2DNode	TEXTURE_DEFAULT_VALUE	SFNode field named texture has default value null (Java syntax) or NULL (XML syntax).
static final String	toField_AMBIENTINTENSITY	toField ROUTE name for SFFloat field named ambientIntensity.
static final String	toField_COLOR	toField ROUTE name for SFColor field named color.
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_DIRECTION	toField ROUTE name for SFVec3f field named direction.
static final String	toField_FARDISTANCE	toField ROUTE name for SFFloat field named farDistance.
static final String	toField_FIELDOFVIEW	toField ROUTE name for SFFloat field named fieldOfView.
static final String	toField_GLOBAL	toField ROUTE name for SFBool field named global.
static final String	toField_INTENSITY	toField ROUTE name for SFFloat field named intensity.
static final String	toField_LOCATION	toField ROUTE name for SFVec3f field named location.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_NEARDISTANCE	toField ROUTE name for SFFloat field named nearDistance.
static final String	toField_ON	toField ROUTE name for SFBool field named on.
static final String	toField_SHADOWINTENSITY	toField ROUTE name for SFFloat field named shadowIntensity.
static final String	toField_SHADOWS	toField ROUTE name for SFBool field named shadows.
static final String	toField_TEXTURE	toField ROUTE name for SFNode field named texture.
static final String	toField_UPVECTOR	toField ROUTE name for SFVec3f field named upVector.
static final float[]	UPVECTOR_DEFAULT_VALUE	SFVec3f field named upVector has default value {0f,1f,0f} (Java syntax) or 0 1 0 (XML syntax).

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
TextureProjector()	Constructor for TextureProjector to initialize member variables with default values.
TextureProjector(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
TextureProjector	addComments(String newComment)	Add comment as String to contained commentsList.
TextureProjector	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
TextureProjector	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
TextureProjector	clearIS()	Utility method to clear SFNode value of IS field.
TextureProjector	clearMetadata()	Utility method to clear SFNode value of metadata field.
TextureProjector	clearTexture()	Utility method to clear SFNode value of texture 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.
float	getAmbientIntensity()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named ambientIntensity.
float	getAspectRatio()	Provide float value within allowed range of (0,infinity) from outputOnly SFFloat field named aspectRatio.
float[]	getColor()	Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.
final String	getComponent()	Defines X3D component for the TextureProjector element: TextureProjection
final int	getComponentLevel()	Provides default X3D component level for this element: 2
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.
float[]	getDirection()	Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
final String	getElementName()	Provides name of this element: TextureProjector
float	getFarDistance()	Provide float value within allowed range of [-1,infinity) from inputOutput SFFloat field named farDistance.
float	getFieldOfView()	Provide float value within allowed range of [0,3.1416] from inputOutput SFFloat field named fieldOfView.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
boolean	getGlobal()	Provide boolean value from inputOutput SFBool field named global.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
float	getIntensity()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named intensity.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
float[]	getLocation()	Provide array of 3-tuple float results from inputOutput SFVec3f field named location.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getNearDistance()	Provide float value within allowed range of [-1,infinity) from inputOutput SFFloat field named nearDistance.
boolean	getOn()	Provide boolean value from inputOutput SFBool field named on.
float	getShadowIntensity()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named shadowIntensity.
boolean	getShadows()	Provide boolean value from inputOutput SFBool field named shadows.
X3DTexture2DNode	getTexture()	Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field texture.
float[]	getUpVector()	Provide array of 3-tuple float results from inputOutput SFVec3f field named upVector.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasElementByNameValue(String nameValue, String elementName)	Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	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	hasTexture()	Indicate whether an object is available for inputOutput SFNode field texture.
final void	initialize()	Initialize all member variables to default values.
TextureProjector	setAmbientIntensity(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAmbientIntensity(float).
TextureProjector	setAmbientIntensity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.
TextureProjector	setAmbientIntensity(SFFloat newValue)	Assign typed object value to SFFloat ambientIntensity field, similar to setAmbientIntensity(float).
TextureProjector	setColor(double[] newArray)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).
TextureProjector	setColor(double red, double green, double blue)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).
TextureProjector	setColor(float[] newValue)	Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.
TextureProjector	setColor(float red, float green, float blue)	Assign values to SFColor color field, similar to setColor(float[]).
TextureProjector	setColor(SFColor newValue)	Assign typed object value to SFColor color field, similar to setColor(float[]).
final TextureProjector	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
TextureProjector	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final TextureProjector	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
TextureProjector	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final TextureProjector	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
TextureProjector	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
TextureProjector	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
TextureProjector	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
TextureProjector	setDirection(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDirection(float[]).
TextureProjector	setDirection(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDirection(float[]).
TextureProjector	setDirection(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.
TextureProjector	setDirection(float x, float y, float z)	Assign values to SFVec3f direction field, similar to setDirection(float[]).
TextureProjector	setDirection(SFVec3f newValue)	Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).
TextureProjector	setFarDistance(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setFarDistance(float).
TextureProjector	setFarDistance(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named farDistance.
TextureProjector	setFarDistance(SFFloat newValue)	Assign typed object value to SFFloat farDistance field, similar to setFarDistance(float).
TextureProjector	setFieldOfView(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setFieldOfView(float).
TextureProjector	setFieldOfView(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named fieldOfView.
TextureProjector	setFieldOfView(SFFloat newValue)	Assign typed object value to SFFloat fieldOfView field, similar to setFieldOfView(float).
TextureProjector	setGlobal(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named global.
TextureProjector	setGlobal(SFBool newValue)	Assign typed object value to SFBool global field, similar to setGlobal(boolean).
final TextureProjector	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
TextureProjector	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
TextureProjector	setIntensity(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setIntensity(float).
TextureProjector	setIntensity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named intensity.
TextureProjector	setIntensity(SFFloat newValue)	Assign typed object value to SFFloat intensity field, similar to setIntensity(float).
TextureProjector	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
TextureProjector	setLocation(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setLocation(float[]).
TextureProjector	setLocation(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setLocation(float[]).
TextureProjector	setLocation(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named location.
TextureProjector	setLocation(float x, float y, float z)	Assign values to SFVec3f location field, similar to setLocation(float[]).
TextureProjector	setLocation(SFVec3f newValue)	Assign typed object value to SFVec3f location field, similar to setLocation(float[]).
TextureProjector	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
TextureProjector	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
TextureProjector	setNearDistance(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setNearDistance(float).
TextureProjector	setNearDistance(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named nearDistance.
TextureProjector	setNearDistance(SFFloat newValue)	Assign typed object value to SFFloat nearDistance field, similar to setNearDistance(float).
TextureProjector	setOn(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named on.
TextureProjector	setOn(SFBool newValue)	Assign typed object value to SFBool on field, similar to setOn(boolean).
TextureProjector	setShadowIntensity(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setShadowIntensity(float).
TextureProjector	setShadowIntensity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named shadowIntensity.
TextureProjector	setShadowIntensity(SFFloat newValue)	Assign typed object value to SFFloat shadowIntensity field, similar to setShadowIntensity(float).
TextureProjector	setShadows(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named shadows.
TextureProjector	setShadows(SFBool newValue)	Assign typed object value to SFBool shadows field, similar to setShadows(boolean).
TextureProjector	setTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texture.
TextureProjector	setTexture(X3DTexture2DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field texture.
TextureProjector	setUpVector(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setUpVector(float[]).
TextureProjector	setUpVector(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setUpVector(float[]).
TextureProjector	setUpVector(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named upVector.
TextureProjector	setUpVector(float x, float y, float z)	Assign values to SFVec3f upVector field, similar to setUpVector(float[]).
TextureProjector	setUpVector(SFVec3f newValue)	Assign typed object value to SFVec3f upVector field, similar to setUpVector(float[]).
final TextureProjector	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
TextureProjector	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
TextureProjector	setUSE(TextureProjector 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: TextureProjector.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the TextureProjector element: TextureProjection

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D TextureProjection component level for this element: 2

See Also:

• Constant Field Values

AMBIENTINTENSITY_DEFAULT_VALUE

public static final float AMBIENTINTENSITY_DEFAULT_VALUE

SFFloat field named ambientIntensity has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

COLOR_DEFAULT_VALUE

public static final float[] COLOR_DEFAULT_VALUE

SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

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

See Also:

• Constant Field Values

DIRECTION_DEFAULT_VALUE

public static final float[] DIRECTION_DEFAULT_VALUE

SFVec3f field named direction has default value {0f,0f,1f} (Java syntax) or 0 0 1 (XML syntax).

FARDISTANCE_DEFAULT_VALUE

public static final float FARDISTANCE_DEFAULT_VALUE

SFFloat field named farDistance has default value -1f (Java syntax) or -1 (XML syntax).

See Also:

• Constant Field Values

FIELDOFVIEW_DEFAULT_VALUE

public static final float FIELDOFVIEW_DEFAULT_VALUE

SFFloat field named fieldOfView has default value 0.7854f (Java syntax) or 0.7854 (XML syntax).

See Also:

• Constant Field Values

GLOBAL_DEFAULT_VALUE

public static final boolean GLOBAL_DEFAULT_VALUE

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

See Also:

• Constant Field Values

INTENSITY_DEFAULT_VALUE

public static final float INTENSITY_DEFAULT_VALUE

SFFloat field named intensity has default value 1f (Java syntax) or 1 (XML syntax).

See Also:

• Constant Field Values

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

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

LOCATION_DEFAULT_VALUE

public static final float[] LOCATION_DEFAULT_VALUE

SFVec3f field named location has default value {0f,0f,0f} (Java syntax) or 0 0 0 (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).

NEARDISTANCE_DEFAULT_VALUE

public static final float NEARDISTANCE_DEFAULT_VALUE

SFFloat field named nearDistance has default value -1f (Java syntax) or -1 (XML syntax).

See Also:

• Constant Field Values

ON_DEFAULT_VALUE

public static final boolean ON_DEFAULT_VALUE

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

See Also:

• Constant Field Values

SHADOWINTENSITY_DEFAULT_VALUE

public static final float SHADOWINTENSITY_DEFAULT_VALUE

SFFloat field named shadowIntensity has default value 1f (Java syntax) or 1 (XML syntax).

See Also:

• Constant Field Values

SHADOWS_DEFAULT_VALUE

public static final boolean SHADOWS_DEFAULT_VALUE

SFBool field named shadows has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

TEXTURE_DEFAULT_VALUE

public static final X3DTexture2DNode TEXTURE_DEFAULT_VALUE

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

UPVECTOR_DEFAULT_VALUE

public static final float[] UPVECTOR_DEFAULT_VALUE

SFVec3f field named upVector has default value {0f,1f,0f} (Java syntax) or 0 1 0 (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 = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN

See Also:

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

fromField_AMBIENTINTENSITY

public static final String fromField_AMBIENTINTENSITY

fromField ROUTE name for SFFloat field named ambientIntensity.

See Also:

• Constant Field Values

toField_AMBIENTINTENSITY

public static final String toField_AMBIENTINTENSITY

toField ROUTE name for SFFloat field named ambientIntensity.

See Also:

• Constant Field Values

fromField_ASPECTRATIO

public static final String fromField_ASPECTRATIO

fromField ROUTE name for SFFloat field named aspectRatio.

See Also:

• Constant Field Values

fromField_COLOR

public static final String fromField_COLOR

fromField ROUTE name for SFColor field named color.

See Also:

• Constant Field Values

toField_COLOR

public static final String toField_COLOR

toField ROUTE name for SFColor field named color.

See Also:

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

public static final String fromField_DIRECTION

fromField ROUTE name for SFVec3f field named direction.

See Also:

• Constant Field Values

toField_DIRECTION

public static final String toField_DIRECTION

toField ROUTE name for SFVec3f field named direction.

See Also:

• Constant Field Values

fromField_FARDISTANCE

public static final String fromField_FARDISTANCE

fromField ROUTE name for SFFloat field named farDistance.

See Also:

• Constant Field Values

toField_FARDISTANCE

public static final String toField_FARDISTANCE

toField ROUTE name for SFFloat field named farDistance.

See Also:

• Constant Field Values

fromField_FIELDOFVIEW

public static final String fromField_FIELDOFVIEW

fromField ROUTE name for SFFloat field named fieldOfView.

See Also:

• Constant Field Values

toField_FIELDOFVIEW

public static final String toField_FIELDOFVIEW

toField ROUTE name for SFFloat field named fieldOfView.

See Also:

• Constant Field Values

fromField_GLOBAL

public static final String fromField_GLOBAL

fromField ROUTE name for SFBool field named global.

See Also:

• Constant Field Values

toField_GLOBAL

public static final String toField_GLOBAL

toField ROUTE name for SFBool field named global.

See Also:

• Constant Field Values

fromField_INTENSITY

public static final String fromField_INTENSITY

fromField ROUTE name for SFFloat field named intensity.

See Also:

• Constant Field Values

toField_INTENSITY

public static final String toField_INTENSITY

toField ROUTE name for SFFloat field named intensity.

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_LOCATION

public static final String fromField_LOCATION

fromField ROUTE name for SFVec3f field named location.

See Also:

• Constant Field Values

toField_LOCATION

public static final String toField_LOCATION

toField ROUTE name for SFVec3f field named location.

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

fromField_NEARDISTANCE

public static final String fromField_NEARDISTANCE

fromField ROUTE name for SFFloat field named nearDistance.

See Also:

• Constant Field Values

toField_NEARDISTANCE

public static final String toField_NEARDISTANCE

toField ROUTE name for SFFloat field named nearDistance.

See Also:

• Constant Field Values

fromField_ON

public static final String fromField_ON

fromField ROUTE name for SFBool field named on.

See Also:

• Constant Field Values

toField_ON

public static final String toField_ON

toField ROUTE name for SFBool field named on.

See Also:

• Constant Field Values

fromField_SHADOWINTENSITY

public static final String fromField_SHADOWINTENSITY

fromField ROUTE name for SFFloat field named shadowIntensity.

See Also:

• Constant Field Values

toField_SHADOWINTENSITY

public static final String toField_SHADOWINTENSITY

toField ROUTE name for SFFloat field named shadowIntensity.

See Also:

• Constant Field Values

fromField_SHADOWS

public static final String fromField_SHADOWS

fromField ROUTE name for SFBool field named shadows.

See Also:

• Constant Field Values

toField_SHADOWS

public static final String toField_SHADOWS

toField ROUTE name for SFBool field named shadows.

See Also:

• Constant Field Values

fromField_TEXTURE

public static final String fromField_TEXTURE

fromField ROUTE name for SFNode field named texture.

See Also:

• Constant Field Values

toField_TEXTURE

public static final String toField_TEXTURE

toField ROUTE name for SFNode field named texture.

See Also:

• Constant Field Values

fromField_UPVECTOR

public static final String fromField_UPVECTOR

fromField ROUTE name for SFVec3f field named upVector.

See Also:

• Constant Field Values

toField_UPVECTOR

public static final String toField_UPVECTOR

toField ROUTE name for SFVec3f field named upVector.

See Also:

• Constant Field Values

Constructor Details

TextureProjector

public TextureProjector()

Constructor for TextureProjector to initialize member variables with default values.

TextureProjector

public TextureProjector(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: TextureProjector

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the TextureProjector element: TextureProjection

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 2

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public 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

getAmbientIntensity

public float getAmbientIntensity()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named ambientIntensity.

Tooltip: [0,1] Brightness of ambient (nondirectional background) emission from the light. Interchange profile

• Hint: this field may be ignored, applying the default value regardless.

Specified by:

getAmbientIntensity in interface TextureProjector

Specified by:

getAmbientIntensity in interface X3DLightNode

Specified by:

getAmbientIntensity in interface X3DTextureProjectorNode

Returns:

value of ambientIntensity field

setAmbientIntensity

public TextureProjector setAmbientIntensity(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.

Tooltip: [0,1] Brightness of ambient (nondirectional background) emission from the light. Interchange profile

• Hint: this field may be ignored, applying the default value regardless.

Specified by:

setAmbientIntensity in interface TextureProjector

Specified by:

setAmbientIntensity in interface X3DLightNode

Specified by:

setAmbientIntensity in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the ambientIntensity field.

Returns:

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

setAmbientIntensity

public TextureProjector setAmbientIntensity(SFFloat newValue)

Assign typed object value to SFFloat ambientIntensity field, similar to setAmbientIntensity(float).

Parameters:

newValue - is new value for the ambientIntensity field.

Returns:

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

setAmbientIntensity

public TextureProjector setAmbientIntensity(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAmbientIntensity(float).

Parameters:

newValue - is new value for field

Returns:

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

getAspectRatio

public float getAspectRatio()

Provide float value within allowed range of (0,infinity) from outputOnly SFFloat field named aspectRatio.

Tooltip: aspectRatio is the ratio of width and height that is projected. *

Specified by:

getAspectRatio in interface TextureProjector

Specified by:

getAspectRatio in interface X3DTextureProjectorNode

Returns:

value of aspectRatio field

getColor

public float[] getColor()

Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.

Tooltip: [0,1] color of light, applied to colors of objects.

• Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

getColor in interface TextureProjector

Specified by:

getColor in interface X3DLightNode

Specified by:

getColor in interface X3DTextureProjectorNode

Returns:

value of color field

setColor

public TextureProjector setColor(float[] newValue)

Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.

Tooltip: [0,1] color of light, applied to colors of objects.

• Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

setColor in interface TextureProjector

Specified by:

setColor in interface X3DLightNode

Specified by:

setColor in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the color field.

Returns:

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

setColor

public TextureProjector setColor(SFColor newValue)

Assign typed object value to SFColor color field, similar to setColor(float[]).

Parameters:

newValue - is new value for the color field.

Returns:

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

setColor

public TextureProjector setColor(float red,
 float green,
 float blue)

Assign values to SFColor color field, similar to setColor(float[]).

Parameters:

red - first component

green - second component

blue - third component

Returns:

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

setColor

public TextureProjector setColor(double red,
 double green,
 double blue)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).

Parameters:

red - first component [0..1]

green - second component [0..1]

blue - third component [0..1]

Returns:

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

setColor

public TextureProjector setColor(double[] newArray)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).

Parameters:

newArray - is new value for field

Returns:

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

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 TextureProjector

Specified by:

getDescription in interface X3DTextureProjectorNode

Returns:

value of description field

setDescription

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

Specified by:

setDescription in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

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

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

getDirection

public float[] getDirection()

Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.

Tooltip: Direction for projection. *

Specified by:

getDirection in interface TextureProjector

Specified by:

getDirection in interface X3DTextureProjectorNode

Returns:

value of direction field

setDirection

public TextureProjector setDirection(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.

Tooltip: Direction for projection. *

Specified by:

setDirection in interface TextureProjector

Specified by:

setDirection in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the direction field.

Returns:

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

setDirection

public TextureProjector setDirection(SFVec3f newValue)

Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).

Parameters:

newValue - is new value for the direction field.

Returns:

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

setDirection

public TextureProjector setDirection(float x,
 float y,
 float z)

Assign values to SFVec3f direction field, similar to setDirection(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setDirection

public TextureProjector setDirection(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDirection(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setDirection

public TextureProjector setDirection(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDirection(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getFarDistance

public float getFarDistance()

Provide float value within allowed range of [-1,infinity) from inputOutput SFFloat field named farDistance.

Tooltip: or (0,+infinity) maximum distance necessary for texture display. *

Specified by:

getFarDistance in interface TextureProjector

Specified by:

getFarDistance in interface X3DTextureProjectorNode

Returns:

value of farDistance field

setFarDistance

public TextureProjector setFarDistance(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named farDistance.

Tooltip: or (0,+infinity) maximum distance necessary for texture display. *

Specified by:

setFarDistance in interface TextureProjector

Specified by:

setFarDistance in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the farDistance field.

Returns:

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

setFarDistance

public TextureProjector setFarDistance(SFFloat newValue)

Assign typed object value to SFFloat farDistance field, similar to setFarDistance(float).

Parameters:

newValue - is new value for the farDistance field.

Returns:

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

setFarDistance

public TextureProjector setFarDistance(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setFarDistance(float).

Parameters:

newValue - is new value for field

Returns:

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

getFieldOfView

public float getFieldOfView()

Provide float value within allowed range of [0,3.1416] from inputOutput SFFloat field named fieldOfView.

Tooltip: Preferred minimum viewing angle for this projection in radians, providing minimum height or minimum width (whichever is smaller). Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.

• Warning: this field differs for TextureProjectorParallel and TextureProjector.

Specified by:

getFieldOfView in interface TextureProjector

Returns:

value of fieldOfView field

setFieldOfView

public TextureProjector setFieldOfView(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named fieldOfView.

Tooltip: Preferred minimum viewing angle for this projection in radians, providing minimum height or minimum width (whichever is smaller). Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.

• Warning: this field differs for TextureProjectorParallel and TextureProjector.

Specified by:

setFieldOfView in interface TextureProjector

Parameters:

newValue - is new value for the fieldOfView field.

Returns:

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

setFieldOfView

public TextureProjector setFieldOfView(SFFloat newValue)

Assign typed object value to SFFloat fieldOfView field, similar to setFieldOfView(float).

Parameters:

newValue - is new value for the fieldOfView field.

Returns:

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

setFieldOfView

public TextureProjector setFieldOfView(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setFieldOfView(float).

Parameters:

newValue - is new value for field

Returns:

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

getGlobal

public boolean getGlobal()

Provide boolean value from inputOutput SFBool field named global.

Tooltip: Global texture projection illuminates all objects within their volume of influence. Scoped texture projection (global false) only illuminates objects within the same transformation hierarchy. *

Specified by:

getGlobal in interface TextureProjector

Specified by:

getGlobal in interface X3DTextureProjectorNode

Returns:

value of global field

setGlobal

public TextureProjector setGlobal(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named global.

Tooltip: Global texture projection illuminates all objects within their volume of influence. Scoped texture projection (global false) only illuminates objects within the same transformation hierarchy. *

Specified by:

setGlobal in interface TextureProjector

Specified by:

setGlobal in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the global field.

Returns:

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

setGlobal

public TextureProjector setGlobal(SFBool newValue)

Assign typed object value to SFBool global field, similar to setGlobal(boolean).

Parameters:

newValue - is new value for the global field.

Returns:

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

getIntensity

public float getIntensity()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named intensity.

Tooltip: [0,1] Brightness of direct emission from the light. *

Specified by:

getIntensity in interface TextureProjector

Specified by:

getIntensity in interface X3DLightNode

Specified by:

getIntensity in interface X3DTextureProjectorNode

Returns:

value of intensity field

setIntensity

public TextureProjector setIntensity(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named intensity.

Tooltip: [0,1] Brightness of direct emission from the light. *

Specified by:

setIntensity in interface TextureProjector

Specified by:

setIntensity in interface X3DLightNode

Specified by:

setIntensity in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the intensity field.

Returns:

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

setIntensity

public TextureProjector setIntensity(SFFloat newValue)

Assign typed object value to SFFloat intensity field, similar to setIntensity(float).

Parameters:

newValue - is new value for the intensity field.

Returns:

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

setIntensity

public TextureProjector setIntensity(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setIntensity(float).

Parameters:

newValue - is new value for field

Returns:

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

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

TextureProjector - 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 TextureProjector clearIS()

Utility method to clear SFNode value of IS field.

Returns:

TextureProjector - 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()

getLocation

public float[] getLocation()

Provide array of 3-tuple float results from inputOutput SFVec3f field named location.

Tooltip: Position of center of texture projection relative to local coordinate system. *

Specified by:

getLocation in interface TextureProjector

Specified by:

getLocation in interface X3DTextureProjectorNode

Returns:

value of location field

setLocation

public TextureProjector setLocation(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named location.

Tooltip: Position of center of texture projection relative to local coordinate system. *

Specified by:

setLocation in interface TextureProjector

Specified by:

setLocation in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the location field.

Returns:

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

setLocation

public TextureProjector setLocation(SFVec3f newValue)

Assign typed object value to SFVec3f location field, similar to setLocation(float[]).

Parameters:

newValue - is new value for the location field.

Returns:

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

setLocation

public TextureProjector setLocation(float x,
 float y,
 float z)

Assign values to SFVec3f location field, similar to setLocation(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setLocation

public TextureProjector setLocation(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setLocation(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setLocation

public TextureProjector setLocation(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setLocation(float[]).

Parameters:

newArray - is new value for field

Returns:

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

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 TextureProjector

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DLightNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DTextureProjectorNode

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

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DLightNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DTextureProjectorNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

TextureProjector - 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 TextureProjector clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getNearDistance

public float getNearDistance()

Provide float value within allowed range of [-1,infinity) from inputOutput SFFloat field named nearDistance.

Tooltip: or (0,+infinity) minimum distance necessary for texture display. *

Specified by:

getNearDistance in interface TextureProjector

Specified by:

getNearDistance in interface X3DTextureProjectorNode

Returns:

value of nearDistance field

setNearDistance

public TextureProjector setNearDistance(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named nearDistance.

Tooltip: or (0,+infinity) minimum distance necessary for texture display. *

Specified by:

setNearDistance in interface TextureProjector

Specified by:

setNearDistance in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the nearDistance field.

Returns:

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

setNearDistance

public TextureProjector setNearDistance(SFFloat newValue)

Assign typed object value to SFFloat nearDistance field, similar to setNearDistance(float).

Parameters:

newValue - is new value for the nearDistance field.

Returns:

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

setNearDistance

public TextureProjector setNearDistance(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setNearDistance(float).

Parameters:

newValue - is new value for field

Returns:

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

getOn

public boolean getOn()

Provide boolean value from inputOutput SFBool field named on.

Tooltip: Enables/disables this texture projection source. *

Specified by:

getOn in interface TextureProjector

Specified by:

getOn in interface X3DLightNode

Specified by:

getOn in interface X3DTextureProjectorNode

Returns:

value of on field

setOn

public TextureProjector setOn(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named on.

Tooltip: Enables/disables this texture projection source. *

Specified by:

setOn in interface TextureProjector

Specified by:

setOn in interface X3DLightNode

Specified by:

setOn in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the on field.

Returns:

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

setOn

public TextureProjector setOn(SFBool newValue)

Assign typed object value to SFBool on field, similar to setOn(boolean).

Parameters:

newValue - is new value for the on field.

Returns:

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

getShadowIntensity

public float getShadowIntensity()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named shadowIntensity.

Tooltip: [0,1] shadowIntensity field defines how much light is obscured by shapes that cast shadows, ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured, full-intensity shadows). *

Specified by:

getShadowIntensity in interface TextureProjector

Specified by:

getShadowIntensity in interface X3DLightNode

Specified by:

getShadowIntensity in interface X3DTextureProjectorNode

Returns:

value of shadowIntensity field

setShadowIntensity

public TextureProjector setShadowIntensity(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named shadowIntensity.

Tooltip: [0,1] shadowIntensity field defines how much light is obscured by shapes that cast shadows, ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured, full-intensity shadows). *

Specified by:

setShadowIntensity in interface TextureProjector

Specified by:

setShadowIntensity in interface X3DLightNode

Specified by:

setShadowIntensity in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the shadowIntensity field.

Returns:

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

setShadowIntensity

public TextureProjector setShadowIntensity(SFFloat newValue)

Assign typed object value to SFFloat shadowIntensity field, similar to setShadowIntensity(float).

Parameters:

newValue - is new value for the shadowIntensity field.

Returns:

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

setShadowIntensity

public TextureProjector setShadowIntensity(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setShadowIntensity(float).

Parameters:

newValue - is new value for field

Returns:

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

getShadows

public boolean getShadows()

Provide boolean value from inputOutput SFBool field named shadows.

Tooltip: shadows field indicates whether or not this light casts a shadow behind illuminated X3DShapeNode geometry. *

Specified by:

getShadows in interface TextureProjector

Specified by:

getShadows in interface X3DLightNode

Specified by:

getShadows in interface X3DTextureProjectorNode

Returns:

value of shadows field

setShadows

public TextureProjector setShadows(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named shadows.

Tooltip: shadows field indicates whether or not this light casts a shadow behind illuminated X3DShapeNode geometry. *

Specified by:

setShadows in interface TextureProjector

Specified by:

setShadows in interface X3DLightNode

Specified by:

setShadows in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the shadows field.

Returns:

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

setShadows

public TextureProjector setShadows(SFBool newValue)

Assign typed object value to SFBool shadows field, similar to setShadows(boolean).

Parameters:

newValue - is new value for the shadows field.

Returns:

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

getTexture

public X3DTexture2DNode getTexture()

Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field texture.

Specified by:

getTexture in interface TextureProjector

Specified by:

getTexture in interface X3DTextureProjectorNode

Returns:

value of texture field

See Also:

• 
  
  Tooltip: [X3DTextureNode] Single contained texture node (ImageTexture, MovieTexture, PixelTexture, MultiTexture) that maps image(s) to surface geometry.
  • Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured.
  • Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
  • Hint: X3D Architecture 18 Texturing component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html
  • Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texture3D.html

setTexture

public TextureProjector setTexture(X3DTexture2DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field texture.

Specified by:

setTexture in interface TextureProjector

Specified by:

setTexture in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the texture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTextureNode] Single contained texture node (ImageTexture, MovieTexture, PixelTexture, MultiTexture) that maps image(s) to surface geometry.
  • Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured.
  • Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
  • Hint: X3D Architecture 18 Texturing component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html
  • Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texture3D.html

clearTexture

public TextureProjector clearTexture()

Utility method to clear SFNode value of texture field.

Returns:

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

setTexture

public TextureProjector setTexture(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texture.

Parameters:

newValue - is new value for the texture field.

Returns:

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

See Also:

• setTexture(org.web3d.x3d.sai.Texturing.X3DTexture2DNode)

hasTexture

public boolean hasTexture()

Indicate whether an object is available for inputOutput SFNode field texture.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getTexture()
• getTextureProtoInstance()

getUpVector

public float[] getUpVector()

Provide array of 3-tuple float results from inputOutput SFVec3f field named upVector.

Tooltip: upVector describes the roll of the camera by defining which direction is up for the camera's orientation. *

Specified by:

getUpVector in interface TextureProjector

Specified by:

getUpVector in interface X3DTextureProjectorNode

Returns:

value of upVector field

setUpVector

public TextureProjector setUpVector(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named upVector.

Tooltip: upVector describes the roll of the camera by defining which direction is up for the camera's orientation. *

Specified by:

setUpVector in interface TextureProjector

Specified by:

setUpVector in interface X3DTextureProjectorNode

Parameters:

newValue - is new value for the upVector field.

Returns:

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

setUpVector

public TextureProjector setUpVector(SFVec3f newValue)

Assign typed object value to SFVec3f upVector field, similar to setUpVector(float[]).

Parameters:

newValue - is new value for the upVector field.

Returns:

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

setUpVector

public TextureProjector setUpVector(float x,
 float y,
 float z)

Assign values to SFVec3f upVector field, similar to setUpVector(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setUpVector

public TextureProjector setUpVector(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setUpVector(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setUpVector

public TextureProjector setUpVector(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setUpVector(float[]).

Parameters:

newArray - is new value for field

Returns:

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

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public TextureProjector addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

TextureProjector - 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 TextureProjector addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public TextureProjector addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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