Class PhysicalMaterial

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Shape.PhysicalMaterial

All Implemented Interfaces:

X3DNode, PhysicalMaterial, X3DAppearanceChildNode, X3DMaterialNode, X3DOneSidedMaterialNode

public class PhysicalMaterial
extends X3DConcreteNode
implements PhysicalMaterial

PhysicalMaterial specifies surface rendering properties for associated geometry nodes.

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. PhysicalMaterial node tooltip: [X3DOneSidedMaterialNode] PhysicalMaterial specifies surface rendering properties for associated geometry nodes. Material attributes are used by the X3D lighting equations during rendering.

• Hint: insert Shape and Appearance nodes before adding material.
• Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
• Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
• Hint: X3D Example Archives, Basic, Universal Media Materials https://www.web3d.org/x3d/content/examples/Basic/UniversalMediaMaterials
• Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/lighting.html#Lightingmodel
• Hint: Rendering https://en.wikipedia.org/wiki/Rendering_(computer_graphics)
• Hint: 3D rendering https://en.wikipedia.org/wiki/3D_rendering
• Hint: Physically based rendering (PBR) https://en.wikipedia.org/wiki/Physically_based_rendering

Note that SFColor provides a variety of color constants.

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:

• X3D Abstract Specification: PhysicalMaterial
• X3D Tooltips: PhysicalMaterial
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final float[]	BASECOLOR_DEFAULT_VALUE	SFColor field named baseColor has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
static final X3DSingleTextureNode	BASETEXTURE_DEFAULT_VALUE	SFNode field named baseTexture has default value null (Java syntax) or NULL (XML syntax).
static final String	BASETEXTUREMAPPING_DEFAULT_VALUE	SFString field named baseTextureMapping has default value equal to an empty string.
static final String	COMPONENT	String constant COMPONENT defines X3D component for the PhysicalMaterial element: Shape
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final float[]	EMISSIVECOLOR_DEFAULT_VALUE	SFColor field named emissiveColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final X3DSingleTextureNode	EMISSIVETEXTURE_DEFAULT_VALUE	SFNode field named emissiveTexture has default value null (Java syntax) or NULL (XML syntax).
static final String	EMISSIVETEXTUREMAPPING_DEFAULT_VALUE	SFString field named emissiveTextureMapping has default value equal to an empty string.
static final String	fromField_BASECOLOR	fromField ROUTE name for SFColor field named baseColor.
static final String	fromField_BASETEXTURE	fromField ROUTE name for SFNode field named baseTexture.
static final String	fromField_BASETEXTUREMAPPING	fromField ROUTE name for SFString field named baseTextureMapping.
static final String	fromField_EMISSIVECOLOR	fromField ROUTE name for SFColor field named emissiveColor.
static final String	fromField_EMISSIVETEXTURE	fromField ROUTE name for SFNode field named emissiveTexture.
static final String	fromField_EMISSIVETEXTUREMAPPING	fromField ROUTE name for SFString field named emissiveTextureMapping.
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 String	fromField_METALLIC	fromField ROUTE name for SFFloat field named metallic.
static final String	fromField_METALLICROUGHNESSTEXTURE	fromField ROUTE name for SFNode field named metallicRoughnessTexture.
static final String	fromField_METALLICROUGHNESSTEXTUREMAPPING	fromField ROUTE name for SFString field named metallicRoughnessTextureMapping.
static final String	fromField_NORMALSCALE	fromField ROUTE name for SFFloat field named normalScale.
static final String	fromField_NORMALTEXTURE	fromField ROUTE name for SFNode field named normalTexture.
static final String	fromField_NORMALTEXTUREMAPPING	fromField ROUTE name for SFString field named normalTextureMapping.
static final String	fromField_OCCLUSIONSTRENGTH	fromField ROUTE name for SFFloat field named occlusionStrength.
static final String	fromField_OCCLUSIONTEXTURE	fromField ROUTE name for SFNode field named occlusionTexture.
static final String	fromField_OCCLUSIONTEXTUREMAPPING	fromField ROUTE name for SFString field named occlusionTextureMapping.
static final String	fromField_ROUGHNESS	fromField ROUTE name for SFFloat field named roughness.
static final String	fromField_TRANSPARENCY	fromField ROUTE name for SFFloat field named transparency.
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 Shape component level for this element: 2
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final float	METALLIC_DEFAULT_VALUE	SFFloat field named metallic has default value 1f (Java syntax) or 1 (XML syntax).
static final X3DSingleTextureNode	METALLICROUGHNESSTEXTURE_DEFAULT_VALUE	SFNode field named metallicRoughnessTexture has default value null (Java syntax) or NULL (XML syntax).
static final String	METALLICROUGHNESSTEXTUREMAPPING_DEFAULT_VALUE	SFString field named metallicRoughnessTextureMapping has default value equal to an empty string.
static final String	NAME	String constant NAME provides name of this element: PhysicalMaterial.
static final float	NORMALSCALE_DEFAULT_VALUE	SFFloat field named normalScale has default value 1f (Java syntax) or 1 (XML syntax).
static final X3DSingleTextureNode	NORMALTEXTURE_DEFAULT_VALUE	SFNode field named normalTexture has default value null (Java syntax) or NULL (XML syntax).
static final String	NORMALTEXTUREMAPPING_DEFAULT_VALUE	SFString field named normalTextureMapping has default value equal to an empty string.
static final float	OCCLUSIONSTRENGTH_DEFAULT_VALUE	SFFloat field named occlusionStrength has default value 1f (Java syntax) or 1 (XML syntax).
static final X3DSingleTextureNode	OCCLUSIONTEXTURE_DEFAULT_VALUE	SFNode field named occlusionTexture has default value null (Java syntax) or NULL (XML syntax).
static final String	OCCLUSIONTEXTUREMAPPING_DEFAULT_VALUE	SFString field named occlusionTextureMapping has default value equal to an empty string.
static final float	ROUGHNESS_DEFAULT_VALUE	SFFloat field named roughness has default value 1f (Java syntax) or 1 (XML syntax).
static final String	toField_BASECOLOR	toField ROUTE name for SFColor field named baseColor.
static final String	toField_BASETEXTURE	toField ROUTE name for SFNode field named baseTexture.
static final String	toField_BASETEXTUREMAPPING	toField ROUTE name for SFString field named baseTextureMapping.
static final String	toField_EMISSIVECOLOR	toField ROUTE name for SFColor field named emissiveColor.
static final String	toField_EMISSIVETEXTURE	toField ROUTE name for SFNode field named emissiveTexture.
static final String	toField_EMISSIVETEXTUREMAPPING	toField ROUTE name for SFString field named emissiveTextureMapping.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_METALLIC	toField ROUTE name for SFFloat field named metallic.
static final String	toField_METALLICROUGHNESSTEXTURE	toField ROUTE name for SFNode field named metallicRoughnessTexture.
static final String	toField_METALLICROUGHNESSTEXTUREMAPPING	toField ROUTE name for SFString field named metallicRoughnessTextureMapping.
static final String	toField_NORMALSCALE	toField ROUTE name for SFFloat field named normalScale.
static final String	toField_NORMALTEXTURE	toField ROUTE name for SFNode field named normalTexture.
static final String	toField_NORMALTEXTUREMAPPING	toField ROUTE name for SFString field named normalTextureMapping.
static final String	toField_OCCLUSIONSTRENGTH	toField ROUTE name for SFFloat field named occlusionStrength.
static final String	toField_OCCLUSIONTEXTURE	toField ROUTE name for SFNode field named occlusionTexture.
static final String	toField_OCCLUSIONTEXTUREMAPPING	toField ROUTE name for SFString field named occlusionTextureMapping.
static final String	toField_ROUGHNESS	toField ROUTE name for SFFloat field named roughness.
static final String	toField_TRANSPARENCY	toField ROUTE name for SFFloat field named transparency.
static final float	TRANSPARENCY_DEFAULT_VALUE	SFFloat field named transparency has default value 0f (Java syntax) or 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
PhysicalMaterial()	Constructor for PhysicalMaterial to initialize member variables with default values.
PhysicalMaterial(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
PhysicalMaterial	addComments(String newComment)	Add comment as String to contained commentsList.
PhysicalMaterial	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
PhysicalMaterial	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
PhysicalMaterial	clearBaseTexture()	Utility method to clear SFNode value of baseTexture field.
PhysicalMaterial	clearEmissiveTexture()	Utility method to clear SFNode value of emissiveTexture field.
PhysicalMaterial	clearIS()	Utility method to clear SFNode value of IS field.
PhysicalMaterial	clearMetadata()	Utility method to clear SFNode value of metadata field.
PhysicalMaterial	clearMetallicRoughnessTexture()	Utility method to clear SFNode value of metallicRoughnessTexture field.
PhysicalMaterial	clearNormalTexture()	Utility method to clear SFNode value of normalTexture field.
PhysicalMaterial	clearOcclusionTexture()	Utility method to clear SFNode value of occlusionTexture 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[]	getBaseColor()	Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named baseColor.
X3DSingleTextureNode	getBaseTexture()	Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field baseTexture.
String	getBaseTextureMapping()	Provide String value from inputOutput SFString field named baseTextureMapping.
final String	getComponent()	Defines X3D component for the PhysicalMaterial element: Shape
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.
final String	getElementName()	Provides name of this element: PhysicalMaterial
float[]	getEmissiveColor()	Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named emissiveColor.
X3DSingleTextureNode	getEmissiveTexture()	Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field emissiveTexture.
String	getEmissiveTextureMapping()	Provide String value from inputOutput SFString field named emissiveTextureMapping.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
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.
float	getMetallic()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named metallic.
X3DSingleTextureNode	getMetallicRoughnessTexture()	Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field metallicRoughnessTexture.
String	getMetallicRoughnessTextureMapping()	Provide String value from inputOutput SFString field named metallicRoughnessTextureMapping.
float	getNormalScale()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named normalScale.
X3DSingleTextureNode	getNormalTexture()	Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field normalTexture.
String	getNormalTextureMapping()	Provide String value from inputOutput SFString field named normalTextureMapping.
float	getOcclusionStrength()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named occlusionStrength.
X3DSingleTextureNode	getOcclusionTexture()	Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field occlusionTexture.
String	getOcclusionTextureMapping()	Provide String value from inputOutput SFString field named occlusionTextureMapping.
float	getRoughness()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named roughness.
float	getTransparency()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasBaseTexture()	Indicate whether an object is available for inputOutput SFNode field baseTexture.
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	hasEmissiveTexture()	Indicate whether an object is available for inputOutput SFNode field emissiveTexture.
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	hasMetallicRoughnessTexture()	Indicate whether an object is available for inputOutput SFNode field metallicRoughnessTexture.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
boolean	hasNormalTexture()	Indicate whether an object is available for inputOutput SFNode field normalTexture.
boolean	hasOcclusionTexture()	Indicate whether an object is available for inputOutput SFNode field occlusionTexture.
final void	initialize()	Initialize all member variables to default values.
PhysicalMaterial	setBaseColor(double[] newArray)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBaseColor(float[]).
PhysicalMaterial	setBaseColor(double red, double green, double blue)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBaseColor(float[]).
PhysicalMaterial	setBaseColor(float[] newValue)	Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named baseColor.
PhysicalMaterial	setBaseColor(float red, float green, float blue)	Assign values to SFColor baseColor field, similar to setBaseColor(float[]).
PhysicalMaterial	setBaseColor(SFColor newValue)	Assign typed object value to SFColor baseColor field, similar to setBaseColor(float[]).
PhysicalMaterial	setBaseTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field baseTexture.
PhysicalMaterial	setBaseTexture(X3DSingleTextureNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) to inputOutput SFNode field baseTexture.
PhysicalMaterial	setBaseTextureMapping(String newValue)	Accessor method to assign String value to inputOutput SFString field named baseTextureMapping.
PhysicalMaterial	setBaseTextureMapping(SFString newValue)	Assign typed object value to SFString baseTextureMapping field, similar to setBaseTextureMapping(String).
final PhysicalMaterial	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
PhysicalMaterial	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final PhysicalMaterial	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
PhysicalMaterial	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final PhysicalMaterial	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
PhysicalMaterial	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
PhysicalMaterial	setEmissiveColor(double[] newArray)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setEmissiveColor(float[]).
PhysicalMaterial	setEmissiveColor(double red, double green, double blue)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setEmissiveColor(float[]).
PhysicalMaterial	setEmissiveColor(float[] newValue)	Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named emissiveColor.
PhysicalMaterial	setEmissiveColor(float red, float green, float blue)	Assign values to SFColor emissiveColor field, similar to setEmissiveColor(float[]).
PhysicalMaterial	setEmissiveColor(SFColor newValue)	Assign typed object value to SFColor emissiveColor field, similar to setEmissiveColor(float[]).
PhysicalMaterial	setEmissiveTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field emissiveTexture.
PhysicalMaterial	setEmissiveTexture(X3DSingleTextureNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) to inputOutput SFNode field emissiveTexture.
PhysicalMaterial	setEmissiveTextureMapping(String newValue)	Accessor method to assign String value to inputOutput SFString field named emissiveTextureMapping.
PhysicalMaterial	setEmissiveTextureMapping(SFString newValue)	Assign typed object value to SFString emissiveTextureMapping field, similar to setEmissiveTextureMapping(String).
final PhysicalMaterial	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
PhysicalMaterial	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
PhysicalMaterial	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
PhysicalMaterial	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
PhysicalMaterial	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
PhysicalMaterial	setMetallic(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMetallic(float).
PhysicalMaterial	setMetallic(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named metallic.
PhysicalMaterial	setMetallic(SFFloat newValue)	Assign typed object value to SFFloat metallic field, similar to setMetallic(float).
PhysicalMaterial	setMetallicRoughnessTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metallicRoughnessTexture.
PhysicalMaterial	setMetallicRoughnessTexture(X3DSingleTextureNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) to inputOutput SFNode field metallicRoughnessTexture.
PhysicalMaterial	setMetallicRoughnessTextureMapping(String newValue)	Accessor method to assign String value to inputOutput SFString field named metallicRoughnessTextureMapping.
PhysicalMaterial	setMetallicRoughnessTextureMapping(SFString newValue)	Assign typed object value to SFString metallicRoughnessTextureMapping field, similar to setMetallicRoughnessTextureMapping(String).
PhysicalMaterial	setNormalScale(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setNormalScale(float).
PhysicalMaterial	setNormalScale(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named normalScale.
PhysicalMaterial	setNormalScale(SFFloat newValue)	Assign typed object value to SFFloat normalScale field, similar to setNormalScale(float).
PhysicalMaterial	setNormalTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normalTexture.
PhysicalMaterial	setNormalTexture(X3DSingleTextureNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) to inputOutput SFNode field normalTexture.
PhysicalMaterial	setNormalTextureMapping(String newValue)	Accessor method to assign String value to inputOutput SFString field named normalTextureMapping.
PhysicalMaterial	setNormalTextureMapping(SFString newValue)	Assign typed object value to SFString normalTextureMapping field, similar to setNormalTextureMapping(String).
PhysicalMaterial	setOcclusionStrength(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setOcclusionStrength(float).
PhysicalMaterial	setOcclusionStrength(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named occlusionStrength.
PhysicalMaterial	setOcclusionStrength(SFFloat newValue)	Assign typed object value to SFFloat occlusionStrength field, similar to setOcclusionStrength(float).
PhysicalMaterial	setOcclusionTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field occlusionTexture.
PhysicalMaterial	setOcclusionTexture(X3DSingleTextureNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) to inputOutput SFNode field occlusionTexture.
PhysicalMaterial	setOcclusionTextureMapping(String newValue)	Accessor method to assign String value to inputOutput SFString field named occlusionTextureMapping.
PhysicalMaterial	setOcclusionTextureMapping(SFString newValue)	Assign typed object value to SFString occlusionTextureMapping field, similar to setOcclusionTextureMapping(String).
PhysicalMaterial	setRoughness(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setRoughness(float).
PhysicalMaterial	setRoughness(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named roughness.
PhysicalMaterial	setRoughness(SFFloat newValue)	Assign typed object value to SFFloat roughness field, similar to setRoughness(float).
PhysicalMaterial	setTransparency(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setTransparency(float).
PhysicalMaterial	setTransparency(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named transparency.
PhysicalMaterial	setTransparency(SFFloat newValue)	Assign typed object value to SFFloat transparency field, similar to setTransparency(float).
final PhysicalMaterial	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
PhysicalMaterial	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
PhysicalMaterial	setUSE(PhysicalMaterial 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: PhysicalMaterial.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the PhysicalMaterial element: Shape

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

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

See Also:

• Constant Field Values

BASECOLOR_DEFAULT_VALUE

public static final float[] BASECOLOR_DEFAULT_VALUE

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

BASETEXTURE_DEFAULT_VALUE

public static final X3DSingleTextureNode BASETEXTURE_DEFAULT_VALUE

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

BASETEXTUREMAPPING_DEFAULT_VALUE

public static final String BASETEXTUREMAPPING_DEFAULT_VALUE

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

See Also:

• Constant Field Values

EMISSIVECOLOR_DEFAULT_VALUE

public static final float[] EMISSIVECOLOR_DEFAULT_VALUE

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

EMISSIVETEXTURE_DEFAULT_VALUE

public static final X3DSingleTextureNode EMISSIVETEXTURE_DEFAULT_VALUE

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

EMISSIVETEXTUREMAPPING_DEFAULT_VALUE

public static final String EMISSIVETEXTUREMAPPING_DEFAULT_VALUE

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

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

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

METALLIC_DEFAULT_VALUE

public static final float METALLIC_DEFAULT_VALUE

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

See Also:

• Constant Field Values

METALLICROUGHNESSTEXTURE_DEFAULT_VALUE

public static final X3DSingleTextureNode METALLICROUGHNESSTEXTURE_DEFAULT_VALUE

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

METALLICROUGHNESSTEXTUREMAPPING_DEFAULT_VALUE

public static final String METALLICROUGHNESSTEXTUREMAPPING_DEFAULT_VALUE

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

See Also:

• Constant Field Values

NORMALSCALE_DEFAULT_VALUE

public static final float NORMALSCALE_DEFAULT_VALUE

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

See Also:

• Constant Field Values

NORMALTEXTURE_DEFAULT_VALUE

public static final X3DSingleTextureNode NORMALTEXTURE_DEFAULT_VALUE

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

NORMALTEXTUREMAPPING_DEFAULT_VALUE

public static final String NORMALTEXTUREMAPPING_DEFAULT_VALUE

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

See Also:

• Constant Field Values

OCCLUSIONSTRENGTH_DEFAULT_VALUE

public static final float OCCLUSIONSTRENGTH_DEFAULT_VALUE

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

See Also:

• Constant Field Values

OCCLUSIONTEXTURE_DEFAULT_VALUE

public static final X3DSingleTextureNode OCCLUSIONTEXTURE_DEFAULT_VALUE

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

OCCLUSIONTEXTUREMAPPING_DEFAULT_VALUE

public static final String OCCLUSIONTEXTUREMAPPING_DEFAULT_VALUE

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

See Also:

• Constant Field Values

ROUGHNESS_DEFAULT_VALUE

public static final float ROUGHNESS_DEFAULT_VALUE

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

See Also:

• Constant Field Values

TRANSPARENCY_DEFAULT_VALUE

public static final float TRANSPARENCY_DEFAULT_VALUE

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

See Also:

• Constant Field Values

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 = "material";
containerField_ALLOWED_VALUES = {"material" }; 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_BASECOLOR

public static final String fromField_BASECOLOR

fromField ROUTE name for SFColor field named baseColor.

See Also:

• Constant Field Values

toField_BASECOLOR

public static final String toField_BASECOLOR

toField ROUTE name for SFColor field named baseColor.

See Also:

• Constant Field Values

fromField_BASETEXTURE

public static final String fromField_BASETEXTURE

fromField ROUTE name for SFNode field named baseTexture.

See Also:

• Constant Field Values

toField_BASETEXTURE

public static final String toField_BASETEXTURE

toField ROUTE name for SFNode field named baseTexture.

See Also:

• Constant Field Values

fromField_BASETEXTUREMAPPING

public static final String fromField_BASETEXTUREMAPPING

fromField ROUTE name for SFString field named baseTextureMapping.

See Also:

• Constant Field Values

toField_BASETEXTUREMAPPING

public static final String toField_BASETEXTUREMAPPING

toField ROUTE name for SFString field named baseTextureMapping.

See Also:

• Constant Field Values

fromField_EMISSIVECOLOR

public static final String fromField_EMISSIVECOLOR

fromField ROUTE name for SFColor field named emissiveColor.

See Also:

• Constant Field Values

toField_EMISSIVECOLOR

public static final String toField_EMISSIVECOLOR

toField ROUTE name for SFColor field named emissiveColor.

See Also:

• Constant Field Values

fromField_EMISSIVETEXTURE

public static final String fromField_EMISSIVETEXTURE

fromField ROUTE name for SFNode field named emissiveTexture.

See Also:

• Constant Field Values

toField_EMISSIVETEXTURE

public static final String toField_EMISSIVETEXTURE

toField ROUTE name for SFNode field named emissiveTexture.

See Also:

• Constant Field Values

fromField_EMISSIVETEXTUREMAPPING

public static final String fromField_EMISSIVETEXTUREMAPPING

fromField ROUTE name for SFString field named emissiveTextureMapping.

See Also:

• Constant Field Values

toField_EMISSIVETEXTUREMAPPING

public static final String toField_EMISSIVETEXTUREMAPPING

toField ROUTE name for SFString field named emissiveTextureMapping.

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

fromField_METALLIC

public static final String fromField_METALLIC

fromField ROUTE name for SFFloat field named metallic.

See Also:

• Constant Field Values

toField_METALLIC

public static final String toField_METALLIC

toField ROUTE name for SFFloat field named metallic.

See Also:

• Constant Field Values

fromField_METALLICROUGHNESSTEXTURE

public static final String fromField_METALLICROUGHNESSTEXTURE

fromField ROUTE name for SFNode field named metallicRoughnessTexture.

See Also:

• Constant Field Values

toField_METALLICROUGHNESSTEXTURE

public static final String toField_METALLICROUGHNESSTEXTURE

toField ROUTE name for SFNode field named metallicRoughnessTexture.

See Also:

• Constant Field Values

fromField_METALLICROUGHNESSTEXTUREMAPPING

public static final String fromField_METALLICROUGHNESSTEXTUREMAPPING

fromField ROUTE name for SFString field named metallicRoughnessTextureMapping.

See Also:

• Constant Field Values

toField_METALLICROUGHNESSTEXTUREMAPPING

public static final String toField_METALLICROUGHNESSTEXTUREMAPPING

toField ROUTE name for SFString field named metallicRoughnessTextureMapping.

See Also:

• Constant Field Values

fromField_NORMALSCALE

public static final String fromField_NORMALSCALE

fromField ROUTE name for SFFloat field named normalScale.

See Also:

• Constant Field Values

toField_NORMALSCALE

public static final String toField_NORMALSCALE

toField ROUTE name for SFFloat field named normalScale.

See Also:

• Constant Field Values

fromField_NORMALTEXTURE

public static final String fromField_NORMALTEXTURE

fromField ROUTE name for SFNode field named normalTexture.

See Also:

• Constant Field Values

toField_NORMALTEXTURE

public static final String toField_NORMALTEXTURE

toField ROUTE name for SFNode field named normalTexture.

See Also:

• Constant Field Values

fromField_NORMALTEXTUREMAPPING

public static final String fromField_NORMALTEXTUREMAPPING

fromField ROUTE name for SFString field named normalTextureMapping.

See Also:

• Constant Field Values

toField_NORMALTEXTUREMAPPING

public static final String toField_NORMALTEXTUREMAPPING

toField ROUTE name for SFString field named normalTextureMapping.

See Also:

• Constant Field Values

fromField_OCCLUSIONSTRENGTH

public static final String fromField_OCCLUSIONSTRENGTH

fromField ROUTE name for SFFloat field named occlusionStrength.

See Also:

• Constant Field Values

toField_OCCLUSIONSTRENGTH

public static final String toField_OCCLUSIONSTRENGTH

toField ROUTE name for SFFloat field named occlusionStrength.

See Also:

• Constant Field Values

fromField_OCCLUSIONTEXTURE

public static final String fromField_OCCLUSIONTEXTURE

fromField ROUTE name for SFNode field named occlusionTexture.

See Also:

• Constant Field Values

toField_OCCLUSIONTEXTURE

public static final String toField_OCCLUSIONTEXTURE

toField ROUTE name for SFNode field named occlusionTexture.

See Also:

• Constant Field Values

fromField_OCCLUSIONTEXTUREMAPPING

public static final String fromField_OCCLUSIONTEXTUREMAPPING

fromField ROUTE name for SFString field named occlusionTextureMapping.

See Also:

• Constant Field Values

toField_OCCLUSIONTEXTUREMAPPING

public static final String toField_OCCLUSIONTEXTUREMAPPING

toField ROUTE name for SFString field named occlusionTextureMapping.

See Also:

• Constant Field Values

fromField_ROUGHNESS

public static final String fromField_ROUGHNESS

fromField ROUTE name for SFFloat field named roughness.

See Also:

• Constant Field Values

toField_ROUGHNESS

public static final String toField_ROUGHNESS

toField ROUTE name for SFFloat field named roughness.

See Also:

• Constant Field Values

fromField_TRANSPARENCY

public static final String fromField_TRANSPARENCY

fromField ROUTE name for SFFloat field named transparency.

See Also:

• Constant Field Values

toField_TRANSPARENCY

public static final String toField_TRANSPARENCY

toField ROUTE name for SFFloat field named transparency.

See Also:

• Constant Field Values

Constructor Details

PhysicalMaterial

public PhysicalMaterial()

Constructor for PhysicalMaterial to initialize member variables with default values.

PhysicalMaterial

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the PhysicalMaterial element: Shape

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

getBaseColor

public float[] getBaseColor()

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

Tooltip: [0,1] similar to diffuseColor, TODO define more precisely. *

Specified by:

getBaseColor in interface PhysicalMaterial

Returns:

value of baseColor field

setBaseColor

public PhysicalMaterial setBaseColor(float[] newValue)

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

Tooltip: [0,1] similar to diffuseColor, TODO define more precisely. *

Specified by:

setBaseColor in interface PhysicalMaterial

Parameters:

newValue - is new value for the baseColor field.

Returns:

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

setBaseColor

public PhysicalMaterial setBaseColor(SFColor newValue)

Assign typed object value to SFColor baseColor field, similar to setBaseColor(float[]).

Parameters:

newValue - is new value for the baseColor field.

Returns:

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

setBaseColor

public PhysicalMaterial setBaseColor(float red,
 float green,
 float blue)

Assign values to SFColor baseColor field, similar to setBaseColor(float[]).

Parameters:

red - first component

green - second component

blue - third component

Returns:

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

setBaseColor

public PhysicalMaterial setBaseColor(double red,
 double green,
 double blue)

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

Parameters:

red - first component [0..1]

green - second component [0..1]

blue - third component [0..1]

Returns:

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

setBaseColor

public PhysicalMaterial setBaseColor(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

getBaseTexture

public X3DSingleTextureNode getBaseTexture()

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

Specified by:

getBaseTexture in interface PhysicalMaterial

Returns:

value of baseTexture field

See Also:

• 
  
  Tooltip: [X3DSingleTextureNode] When applying baseColor for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
  • Hint: if texture node is NULL or unspecified, no effect is applied to material values.
  • Hint: contained texture node must include containerField='baseTexture'.

setBaseTexture

public PhysicalMaterial setBaseTexture(X3DSingleTextureNode newValue)

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

Specified by:

setBaseTexture in interface PhysicalMaterial

Parameters:

newValue - is new value for the baseTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DSingleTextureNode] When applying baseColor for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
  • Hint: if texture node is NULL or unspecified, no effect is applied to material values.
  • Hint: contained texture node must include containerField='baseTexture'.

clearBaseTexture

public PhysicalMaterial clearBaseTexture()

Utility method to clear SFNode value of baseTexture field.

Returns:

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

setBaseTexture

public PhysicalMaterial setBaseTexture(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the baseTexture field.

Returns:

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

See Also:

• setBaseTexture(org.web3d.x3d.sai.Texturing.X3DSingleTextureNode)

hasBaseTexture

public boolean hasBaseTexture()

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

Returns:

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

See Also:

• getBaseTexture()
• getBaseTextureProtoInstance()

getBaseTextureMapping

public String getBaseTextureMapping()

Provide String value from inputOutput SFString field named baseTextureMapping.

Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.

• Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator

Specified by:

getBaseTextureMapping in interface PhysicalMaterial

Returns:

value of baseTextureMapping field

setBaseTextureMapping

public PhysicalMaterial setBaseTextureMapping(String newValue)

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

Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.

• Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator

Specified by:

setBaseTextureMapping in interface PhysicalMaterial

Parameters:

newValue - is new value for the baseTextureMapping field.

Returns:

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

setBaseTextureMapping

public PhysicalMaterial setBaseTextureMapping(SFString newValue)

Assign typed object value to SFString baseTextureMapping field, similar to setBaseTextureMapping(String).

Parameters:

newValue - is new value for the baseTextureMapping field.

Returns:

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

getEmissiveColor

public float[] getEmissiveColor()

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

Tooltip: [0,1] how much glowing light is emitted from this object.

• Hint: emissiveColors glow even when all lights are off.
• Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
• Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
• Warning: bright emissiveColor values can wash out other colors and some textures.

Specified by:

getEmissiveColor in interface PhysicalMaterial

Returns:

value of emissiveColor field

setEmissiveColor

public PhysicalMaterial setEmissiveColor(float[] newValue)

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

Tooltip: [0,1] how much glowing light is emitted from this object.

• Hint: emissiveColors glow even when all lights are off.
• Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
• Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
• Warning: bright emissiveColor values can wash out other colors and some textures.

Specified by:

setEmissiveColor in interface PhysicalMaterial

Parameters:

newValue - is new value for the emissiveColor field.

Returns:

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

setEmissiveColor

public PhysicalMaterial setEmissiveColor(SFColor newValue)

Assign typed object value to SFColor emissiveColor field, similar to setEmissiveColor(float[]).

Parameters:

newValue - is new value for the emissiveColor field.

Returns:

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

setEmissiveColor

public PhysicalMaterial setEmissiveColor(float red,
 float green,
 float blue)

Assign values to SFColor emissiveColor field, similar to setEmissiveColor(float[]).

Parameters:

red - first component

green - second component

blue - third component

Returns:

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

setEmissiveColor

public PhysicalMaterial setEmissiveColor(double red,
 double green,
 double blue)

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

Parameters:

red - first component [0..1]

green - second component [0..1]

blue - third component [0..1]

Returns:

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

setEmissiveColor

public PhysicalMaterial setEmissiveColor(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

getEmissiveTexture

public X3DSingleTextureNode getEmissiveTexture()

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

Specified by:

getEmissiveTexture in interface PhysicalMaterial

Returns:

value of emissiveTexture field

See Also:

• 
  
  Tooltip: [X3DSingleTextureNode] When applying emissiveColor for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
  • Hint: if texture node is NULL or unspecified, no effect is applied to material values.
  • Hint: contained texture node must include containerField='emissiveTexture'.

setEmissiveTexture

public PhysicalMaterial setEmissiveTexture(X3DSingleTextureNode newValue)

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

Specified by:

setEmissiveTexture in interface PhysicalMaterial

Parameters:

newValue - is new value for the emissiveTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DSingleTextureNode] When applying emissiveColor for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
  • Hint: if texture node is NULL or unspecified, no effect is applied to material values.
  • Hint: contained texture node must include containerField='emissiveTexture'.

clearEmissiveTexture

public PhysicalMaterial clearEmissiveTexture()

Utility method to clear SFNode value of emissiveTexture field.

Returns:

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

setEmissiveTexture

public PhysicalMaterial setEmissiveTexture(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the emissiveTexture field.

Returns:

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

See Also:

• setEmissiveTexture(org.web3d.x3d.sai.Texturing.X3DSingleTextureNode)

hasEmissiveTexture

public boolean hasEmissiveTexture()

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

Returns:

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

See Also:

• getEmissiveTexture()
• getEmissiveTextureProtoInstance()

getEmissiveTextureMapping

public String getEmissiveTextureMapping()

Provide String value from inputOutput SFString field named emissiveTextureMapping.

Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.

• Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator

Specified by:

getEmissiveTextureMapping in interface PhysicalMaterial

Specified by:

getEmissiveTextureMapping in interface X3DOneSidedMaterialNode

Returns:

value of emissiveTextureMapping field

setEmissiveTextureMapping

public PhysicalMaterial setEmissiveTextureMapping(String newValue)

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

Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.

• Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator

Specified by:

setEmissiveTextureMapping in interface PhysicalMaterial

Specified by:

setEmissiveTextureMapping in interface X3DOneSidedMaterialNode

Parameters:

newValue - is new value for the emissiveTextureMapping field.

Returns:

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

setEmissiveTextureMapping

public PhysicalMaterial setEmissiveTextureMapping(SFString newValue)

Assign typed object value to SFString emissiveTextureMapping field, similar to setEmissiveTextureMapping(String).

Parameters:

newValue - is new value for the emissiveTextureMapping field.

Returns:

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

Specified by:

getMetadata in interface X3DAppearanceChildNode

Specified by:

getMetadata in interface X3DMaterialNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DOneSidedMaterialNode

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

Specified by:

setMetadata in interface X3DAppearanceChildNode

Specified by:

setMetadata in interface X3DMaterialNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DOneSidedMaterialNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getMetallic

public float getMetallic()

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

Tooltip: [0,1] metallic is a PBR parameter (TODO elaborate). *

Specified by:

getMetallic in interface PhysicalMaterial

Returns:

value of metallic field

setMetallic

public PhysicalMaterial setMetallic(float newValue)

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

Tooltip: [0,1] metallic is a PBR parameter (TODO elaborate). *

Specified by:

setMetallic in interface PhysicalMaterial

Parameters:

newValue - is new value for the metallic field.

Returns:

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

setMetallic

public PhysicalMaterial setMetallic(SFFloat newValue)

Assign typed object value to SFFloat metallic field, similar to setMetallic(float).

Parameters:

newValue - is new value for the metallic field.

Returns:

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

setMetallic

public PhysicalMaterial setMetallic(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getMetallicRoughnessTexture

public X3DSingleTextureNode getMetallicRoughnessTexture()

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

Specified by:

getMetallicRoughnessTexture in interface PhysicalMaterial

Returns:

value of metallicRoughnessTexture field

See Also:

• 
  
  Tooltip: [X3DSingleTextureNode] When applying metallic for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
  • Hint: if texture node is NULL or unspecified, no effect is applied to material values.
  • Hint: contained texture node must include containerField='metallicRoughnessTexture'.

setMetallicRoughnessTexture

public PhysicalMaterial setMetallicRoughnessTexture(X3DSingleTextureNode newValue)

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

Specified by:

setMetallicRoughnessTexture in interface PhysicalMaterial

Parameters:

newValue - is new value for the metallicRoughnessTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DSingleTextureNode] When applying metallic for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
  • Hint: if texture node is NULL or unspecified, no effect is applied to material values.
  • Hint: contained texture node must include containerField='metallicRoughnessTexture'.

clearMetallicRoughnessTexture

public PhysicalMaterial clearMetallicRoughnessTexture()

Utility method to clear SFNode value of metallicRoughnessTexture field.

Returns:

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

setMetallicRoughnessTexture

public PhysicalMaterial setMetallicRoughnessTexture(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the metallicRoughnessTexture field.

Returns:

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

See Also:

• setMetallicRoughnessTexture(org.web3d.x3d.sai.Texturing.X3DSingleTextureNode)

hasMetallicRoughnessTexture

public boolean hasMetallicRoughnessTexture()

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

Returns:

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

See Also:

• getMetallicRoughnessTexture()
• getMetallicRoughnessTextureProtoInstance()

getMetallicRoughnessTextureMapping

public String getMetallicRoughnessTextureMapping()

Provide String value from inputOutput SFString field named metallicRoughnessTextureMapping.

Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.

• Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator

Specified by:

getMetallicRoughnessTextureMapping in interface PhysicalMaterial

Returns:

value of metallicRoughnessTextureMapping field

setMetallicRoughnessTextureMapping

public PhysicalMaterial setMetallicRoughnessTextureMapping(String newValue)

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

Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.

• Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator

Specified by:

setMetallicRoughnessTextureMapping in interface PhysicalMaterial

Parameters:

newValue - is new value for the metallicRoughnessTextureMapping field.

Returns:

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

setMetallicRoughnessTextureMapping

public PhysicalMaterial setMetallicRoughnessTextureMapping(SFString newValue)

Assign typed object value to SFString metallicRoughnessTextureMapping field, similar to setMetallicRoughnessTextureMapping(String).

Parameters:

newValue - is new value for the metallicRoughnessTextureMapping field.

Returns:

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

getNormalScale

public float getNormalScale()

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

Tooltip: [0,infinity] normalScale controls the degree to which normalTexture RGB values apply XYZ-normal bump mapping to pixels in the parent material.

• Hint: normalScale only affects computation of normalTexture modulations that affect lighting of characteristics of the parent Material and has no relation to normal vectors defined by corresponding geometry.
• Hint: normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping

Specified by:

getNormalScale in interface PhysicalMaterial

Specified by:

getNormalScale in interface X3DOneSidedMaterialNode

Returns:

value of normalScale field

setNormalScale

public PhysicalMaterial setNormalScale(float newValue)

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

Tooltip: [0,infinity] normalScale controls the degree to which normalTexture RGB values apply XYZ-normal bump mapping to pixels in the parent material.

• Hint: normalScale only affects computation of normalTexture modulations that affect lighting of characteristics of the parent Material and has no relation to normal vectors defined by corresponding geometry.
• Hint: normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping

Specified by:

setNormalScale in interface PhysicalMaterial

Specified by:

setNormalScale in interface X3DOneSidedMaterialNode

Parameters:

newValue - is new value for the normalScale field.

Returns:

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

setNormalScale

public PhysicalMaterial setNormalScale(SFFloat newValue)

Assign typed object value to SFFloat normalScale field, similar to setNormalScale(float).

Parameters:

newValue - is new value for the normalScale field.

Returns:

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

setNormalScale

public PhysicalMaterial setNormalScale(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getNormalTexture

public X3DSingleTextureNode getNormalTexture()

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

Specified by:

getNormalTexture in interface PhysicalMaterial

Returns:

value of normalTexture field

See Also:

• 
  
  Tooltip: [X3DSingleTextureNode] When applying normalScale for this material node, the contained texture modulates the texture across the surface.
  • Hint: normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping
  • Hint: if texture node is NULL or unspecified, no effect is applied to material values.
  • Hint: contained texture node must include containerField='normalTexture'

setNormalTexture

public PhysicalMaterial setNormalTexture(X3DSingleTextureNode newValue)

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

Specified by:

setNormalTexture in interface PhysicalMaterial

Parameters:

newValue - is new value for the normalTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DSingleTextureNode] When applying normalScale for this material node, the contained texture modulates the texture across the surface.
  • Hint: normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping
  • Hint: if texture node is NULL or unspecified, no effect is applied to material values.
  • Hint: contained texture node must include containerField='normalTexture'

clearNormalTexture

public PhysicalMaterial clearNormalTexture()

Utility method to clear SFNode value of normalTexture field.

Returns:

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

setNormalTexture

public PhysicalMaterial setNormalTexture(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the normalTexture field.

Returns:

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

See Also:

• setNormalTexture(org.web3d.x3d.sai.Texturing.X3DSingleTextureNode)

hasNormalTexture

public boolean hasNormalTexture()

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

Returns:

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

See Also:

• getNormalTexture()
• getNormalTextureProtoInstance()

getNormalTextureMapping

public String getNormalTextureMapping()

Provide String value from inputOutput SFString field named normalTextureMapping.

Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.

• Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator

Specified by:

getNormalTextureMapping in interface PhysicalMaterial

Specified by:

getNormalTextureMapping in interface X3DOneSidedMaterialNode

Returns:

value of normalTextureMapping field

setNormalTextureMapping

public PhysicalMaterial setNormalTextureMapping(String newValue)

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

Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.

• Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator

Specified by:

setNormalTextureMapping in interface PhysicalMaterial

Specified by:

setNormalTextureMapping in interface X3DOneSidedMaterialNode

Parameters:

newValue - is new value for the normalTextureMapping field.

Returns:

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

setNormalTextureMapping

public PhysicalMaterial setNormalTextureMapping(SFString newValue)

Assign typed object value to SFString normalTextureMapping field, similar to setNormalTextureMapping(String).

Parameters:

newValue - is new value for the normalTextureMapping field.

Returns:

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

getOcclusionStrength

public float getOcclusionStrength()

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

Tooltip: [0,1] occlusionStrength indicates areas of indirect lighting, typically called ambient occlusion. Higher values indicate areas that should receive full indirect lighting and lower values indicate no indirect lighting.

• Hint: only the Red channel of the texture is used for occlusion computations, other channels are ignored.
• Hint: https://en.wikipedia.org/wiki/Ambient_occlusion

Specified by:

getOcclusionStrength in interface PhysicalMaterial

Returns:

value of occlusionStrength field

setOcclusionStrength

public PhysicalMaterial setOcclusionStrength(float newValue)

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

Tooltip: [0,1] occlusionStrength indicates areas of indirect lighting, typically called ambient occlusion. Higher values indicate areas that should receive full indirect lighting and lower values indicate no indirect lighting.

• Hint: only the Red channel of the texture is used for occlusion computations, other channels are ignored.
• Hint: https://en.wikipedia.org/wiki/Ambient_occlusion

Specified by:

setOcclusionStrength in interface PhysicalMaterial

Parameters:

newValue - is new value for the occlusionStrength field.

Returns:

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

setOcclusionStrength

public PhysicalMaterial setOcclusionStrength(SFFloat newValue)

Assign typed object value to SFFloat occlusionStrength field, similar to setOcclusionStrength(float).

Parameters:

newValue - is new value for the occlusionStrength field.

Returns:

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

setOcclusionStrength

public PhysicalMaterial setOcclusionStrength(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getOcclusionTexture

public X3DSingleTextureNode getOcclusionTexture()

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

Specified by:

getOcclusionTexture in interface PhysicalMaterial

Returns:

value of occlusionTexture field

See Also:

• 
  
  Tooltip: [X3DSingleTextureNode] When applying occlusionStrength for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
  • Hint: if texture node is NULL or unspecified, no effect is applied to material values.
  • Hint: contained texture node must include containerField='occlusionTexture'.

setOcclusionTexture

public PhysicalMaterial setOcclusionTexture(X3DSingleTextureNode newValue)

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

Specified by:

setOcclusionTexture in interface PhysicalMaterial

Parameters:

newValue - is new value for the occlusionTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DSingleTextureNode] When applying occlusionStrength for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
  • Hint: if texture node is NULL or unspecified, no effect is applied to material values.
  • Hint: contained texture node must include containerField='occlusionTexture'.

clearOcclusionTexture

public PhysicalMaterial clearOcclusionTexture()

Utility method to clear SFNode value of occlusionTexture field.

Returns:

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

setOcclusionTexture

public PhysicalMaterial setOcclusionTexture(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the occlusionTexture field.

Returns:

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

See Also:

• setOcclusionTexture(org.web3d.x3d.sai.Texturing.X3DSingleTextureNode)

hasOcclusionTexture

public boolean hasOcclusionTexture()

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

Returns:

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

See Also:

• getOcclusionTexture()
• getOcclusionTextureProtoInstance()

getOcclusionTextureMapping

public String getOcclusionTextureMapping()

Provide String value from inputOutput SFString field named occlusionTextureMapping.

Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.

• Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator

Specified by:

getOcclusionTextureMapping in interface PhysicalMaterial

Returns:

value of occlusionTextureMapping field

setOcclusionTextureMapping

public PhysicalMaterial setOcclusionTextureMapping(String newValue)

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

Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.

• Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator

Specified by:

setOcclusionTextureMapping in interface PhysicalMaterial

Parameters:

newValue - is new value for the occlusionTextureMapping field.

Returns:

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

setOcclusionTextureMapping

public PhysicalMaterial setOcclusionTextureMapping(SFString newValue)

Assign typed object value to SFString occlusionTextureMapping field, similar to setOcclusionTextureMapping(String).

Parameters:

newValue - is new value for the occlusionTextureMapping field.

Returns:

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

getRoughness

public float getRoughness()

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

Tooltip: [0,1] roughness is a PBR parameter (TODO elaborate). *

Specified by:

getRoughness in interface PhysicalMaterial

Returns:

value of roughness field

setRoughness

public PhysicalMaterial setRoughness(float newValue)

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

Tooltip: [0,1] roughness is a PBR parameter (TODO elaborate). *

Specified by:

setRoughness in interface PhysicalMaterial

Parameters:

newValue - is new value for the roughness field.

Returns:

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

setRoughness

public PhysicalMaterial setRoughness(SFFloat newValue)

Assign typed object value to SFFloat roughness field, similar to setRoughness(float).

Parameters:

newValue - is new value for the roughness field.

Returns:

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

setRoughness

public PhysicalMaterial setRoughness(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getTransparency

public float getTransparency()

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

Tooltip: [0,1] how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile

• Hint: transparency < .5 opaque, transparency > .5 transparent.

Specified by:

getTransparency in interface PhysicalMaterial

Returns:

value of transparency field

setTransparency

public PhysicalMaterial setTransparency(float newValue)

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

Tooltip: [0,1] how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile

• Hint: transparency < .5 opaque, transparency > .5 transparent.

Specified by:

setTransparency in interface PhysicalMaterial

Parameters:

newValue - is new value for the transparency field.

Returns:

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

setTransparency

public PhysicalMaterial setTransparency(SFFloat newValue)

Assign typed object value to SFFloat transparency field, similar to setTransparency(float).

Parameters:

newValue - is new value for the transparency field.

Returns:

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

setTransparency

public PhysicalMaterial setTransparency(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public PhysicalMaterial addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public PhysicalMaterial addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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