Package org.web3d.x3d.jsail.Shape
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.
X3D node tooltip: (X3D version 4.0 draft) [X3DOneSidedMaterialNode] PhysicalMaterial specifies surface rendering properties for associated geometry nodes. Material attributes are used by the X3D lighting equations during 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.
X3D node tooltip: (X3D version 4.0 draft) [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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/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.
-
Field Summary
Fields Modifier and Type Field Description static float[]
BASECOLOR_DEFAULT_VALUE
SFColor field named baseColor has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).static X3DSingleTextureNode
BASETEXTURE_DEFAULT_VALUE
SFNode field named baseTexture has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
BASETEXTUREMAPPING_DEFAULT_VALUE
SFString field named baseTextureMapping has default value equal to an empty string.static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the PhysicalMaterial element: Shapestatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static float[]
EMISSIVECOLOR_DEFAULT_VALUE
SFColor field named emissiveColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static X3DSingleTextureNode
EMISSIVETEXTURE_DEFAULT_VALUE
SFNode field named emissiveTexture has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
EMISSIVETEXTUREMAPPING_DEFAULT_VALUE
SFString field named emissiveTextureMapping has default value equal to an empty string.static java.lang.String
fromField_BASECOLOR
fromField ROUTE name for SFColor field named baseColor.static java.lang.String
fromField_BASETEXTURE
fromField ROUTE name for SFNode field named baseTexture.static java.lang.String
fromField_BASETEXTUREMAPPING
fromField ROUTE name for SFString field named baseTextureMapping.static java.lang.String
fromField_EMISSIVECOLOR
fromField ROUTE name for SFColor field named emissiveColor.static java.lang.String
fromField_EMISSIVETEXTURE
fromField ROUTE name for SFNode field named emissiveTexture.static java.lang.String
fromField_EMISSIVETEXTUREMAPPING
fromField ROUTE name for SFString field named emissiveTextureMapping.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_METALLIC
fromField ROUTE name for SFFloat field named metallic.static java.lang.String
fromField_METALLICROUGHNESSTEXTURE
fromField ROUTE name for SFNode field named metallicRoughnessTexture.static java.lang.String
fromField_METALLICROUGHNESSTEXTUREMAPPING
fromField ROUTE name for SFString field named metallicRoughnessTextureMapping.static java.lang.String
fromField_NORMALSCALE
fromField ROUTE name for SFFloat field named normalScale.static java.lang.String
fromField_NORMALTEXTURE
fromField ROUTE name for SFNode field named normalTexture.static java.lang.String
fromField_NORMALTEXTUREMAPPING
fromField ROUTE name for SFString field named normalTextureMapping.static java.lang.String
fromField_OCCLUSIONSTRENGTH
fromField ROUTE name for SFFloat field named occlusionStrength.static java.lang.String
fromField_OCCLUSIONTEXTURE
fromField ROUTE name for SFNode field named occlusionTexture.static java.lang.String
fromField_OCCLUSIONTEXTUREMAPPING
fromField ROUTE name for SFString field named occlusionTextureMapping.static java.lang.String
fromField_ROUGHNESS
fromField ROUTE name for SFFloat field named roughness.static java.lang.String
fromField_TRANSPARENCY
fromField ROUTE name for SFFloat field named transparency.static IS
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Shape component level for this element: 2static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static float
METALLIC_DEFAULT_VALUE
SFFloat field named metallic has default value 1f (Java syntax) or 1 (XML syntax).static X3DSingleTextureNode
METALLICROUGHNESSTEXTURE_DEFAULT_VALUE
SFNode field named metallicRoughnessTexture has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
METALLICROUGHNESSTEXTUREMAPPING_DEFAULT_VALUE
SFString field named metallicRoughnessTextureMapping has default value equal to an empty string.static java.lang.String
NAME
String constant NAME provides name of this element: PhysicalMaterial.static float
NORMALSCALE_DEFAULT_VALUE
SFFloat field named normalScale has default value 1f (Java syntax) or 1 (XML syntax).static X3DSingleTextureNode
NORMALTEXTURE_DEFAULT_VALUE
SFNode field named normalTexture has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NORMALTEXTUREMAPPING_DEFAULT_VALUE
SFString field named normalTextureMapping has default value equal to an empty string.static float
OCCLUSIONSTRENGTH_DEFAULT_VALUE
SFFloat field named occlusionStrength has default value 1f (Java syntax) or 1 (XML syntax).static X3DSingleTextureNode
OCCLUSIONTEXTURE_DEFAULT_VALUE
SFNode field named occlusionTexture has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
OCCLUSIONTEXTUREMAPPING_DEFAULT_VALUE
SFString field named occlusionTextureMapping has default value equal to an empty string.static float
ROUGHNESS_DEFAULT_VALUE
SFFloat field named roughness has default value 1f (Java syntax) or 1 (XML syntax).static java.lang.String
toField_BASECOLOR
toField ROUTE name for SFColor field named baseColor.static java.lang.String
toField_BASETEXTURE
toField ROUTE name for SFNode field named baseTexture.static java.lang.String
toField_BASETEXTUREMAPPING
toField ROUTE name for SFString field named baseTextureMapping.static java.lang.String
toField_EMISSIVECOLOR
toField ROUTE name for SFColor field named emissiveColor.static java.lang.String
toField_EMISSIVETEXTURE
toField ROUTE name for SFNode field named emissiveTexture.static java.lang.String
toField_EMISSIVETEXTUREMAPPING
toField ROUTE name for SFString field named emissiveTextureMapping.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_METALLIC
toField ROUTE name for SFFloat field named metallic.static java.lang.String
toField_METALLICROUGHNESSTEXTURE
toField ROUTE name for SFNode field named metallicRoughnessTexture.static java.lang.String
toField_METALLICROUGHNESSTEXTUREMAPPING
toField ROUTE name for SFString field named metallicRoughnessTextureMapping.static java.lang.String
toField_NORMALSCALE
toField ROUTE name for SFFloat field named normalScale.static java.lang.String
toField_NORMALTEXTURE
toField ROUTE name for SFNode field named normalTexture.static java.lang.String
toField_NORMALTEXTUREMAPPING
toField ROUTE name for SFString field named normalTextureMapping.static java.lang.String
toField_OCCLUSIONSTRENGTH
toField ROUTE name for SFFloat field named occlusionStrength.static java.lang.String
toField_OCCLUSIONTEXTURE
toField ROUTE name for SFNode field named occlusionTexture.static java.lang.String
toField_OCCLUSIONTEXTUREMAPPING
toField ROUTE name for SFString field named occlusionTextureMapping.static java.lang.String
toField_ROUGHNESS
toField ROUTE name for SFFloat field named roughness.static java.lang.String
toField_TRANSPARENCY
toField ROUTE name for SFFloat field named transparency.static 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
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description PhysicalMaterial()
Constructor for PhysicalMaterial to initialize member variables with default values.PhysicalMaterial(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description PhysicalMaterial
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.PhysicalMaterial
addComments(java.lang.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(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.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.java.lang.String
getBaseTextureMapping()
Provide String value from inputOutput SFString field named baseTextureMapping.java.lang.String
getComponent()
Defines X3D component for the PhysicalMaterial element: Shapeint
getComponentLevel()
Provides default X3D component level for this element: 2java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: PhysicalMaterialfloat[]
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.java.lang.String
getEmissiveTextureMapping()
Provide String value from inputOutput SFString field named emissiveTextureMapping.java.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.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.java.lang.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.java.lang.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.java.lang.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.java.lang.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(java.lang.String nameValue, java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
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(java.lang.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.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 tosetBaseColor(float[])
.PhysicalMaterial
setBaseColor(double red, double green, double blue)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBaseColor(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 tosetBaseColor(float[])
.PhysicalMaterial
setBaseColor(SFColor newValue)
Assign typed object value to SFColor baseColor field, similar tosetBaseColor(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(java.lang.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 tosetBaseTextureMapping(String)
.PhysicalMaterial
setCssClass(java.lang.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 tosetCssClass(String)
.PhysicalMaterial
setDEF(java.lang.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 tosetDEF(String)
.PhysicalMaterial
setEmissiveColor(double[] newArray)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetEmissiveColor(float[])
.PhysicalMaterial
setEmissiveColor(double red, double green, double blue)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetEmissiveColor(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 tosetEmissiveColor(float[])
.PhysicalMaterial
setEmissiveColor(SFColor newValue)
Assign typed object value to SFColor emissiveColor field, similar tosetEmissiveColor(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(java.lang.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 tosetEmissiveTextureMapping(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 tosetMetallic(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 tosetMetallic(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(java.lang.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 tosetMetallicRoughnessTextureMapping(String)
.PhysicalMaterial
setNormalScale(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetNormalScale(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 tosetNormalScale(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(java.lang.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 tosetNormalTextureMapping(String)
.PhysicalMaterial
setOcclusionStrength(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetOcclusionStrength(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 tosetOcclusionStrength(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(java.lang.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 tosetOcclusionTextureMapping(String)
.PhysicalMaterial
setRoughness(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetRoughness(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 tosetRoughness(float)
.PhysicalMaterial
setTransparency(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetTransparency(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 tosetTransparency(float)
.PhysicalMaterial
setUSE(java.lang.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 tosetUSE(String)
.PhysicalMaterial
setUSE(PhysicalMaterial DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.String
validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: PhysicalMaterial.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the PhysicalMaterial element: Shape- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger 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_VALUESFColor field named baseColor has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax). -
BASETEXTURE_DEFAULT_VALUE
SFNode field named baseTexture has default value null (Java syntax) or NULL (XML syntax). -
BASETEXTUREMAPPING_DEFAULT_VALUE
public static final java.lang.String BASETEXTUREMAPPING_DEFAULT_VALUESFString 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_VALUESFColor field named emissiveColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
EMISSIVETEXTURE_DEFAULT_VALUE
SFNode field named emissiveTexture has default value null (Java syntax) or NULL (XML syntax). -
EMISSIVETEXTUREMAPPING_DEFAULT_VALUE
public static final java.lang.String EMISSIVETEXTUREMAPPING_DEFAULT_VALUESFString field named emissiveTextureMapping has default value equal to an empty string.- See Also:
- Constant Field Values
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
METALLIC_DEFAULT_VALUE
public static final float METALLIC_DEFAULT_VALUESFFloat field named metallic has default value 1f (Java syntax) or 1 (XML syntax).- See Also:
- Constant Field Values
-
METALLICROUGHNESSTEXTURE_DEFAULT_VALUE
SFNode field named metallicRoughnessTexture has default value null (Java syntax) or NULL (XML syntax). -
METALLICROUGHNESSTEXTUREMAPPING_DEFAULT_VALUE
public static final java.lang.String METALLICROUGHNESSTEXTUREMAPPING_DEFAULT_VALUESFString 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_VALUESFFloat field named normalScale has default value 1f (Java syntax) or 1 (XML syntax).- See Also:
- Constant Field Values
-
NORMALTEXTURE_DEFAULT_VALUE
SFNode field named normalTexture has default value null (Java syntax) or NULL (XML syntax). -
NORMALTEXTUREMAPPING_DEFAULT_VALUE
public static final java.lang.String NORMALTEXTUREMAPPING_DEFAULT_VALUESFString 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_VALUESFFloat field named occlusionStrength has default value 1f (Java syntax) or 1 (XML syntax).- See Also:
- Constant Field Values
-
OCCLUSIONTEXTURE_DEFAULT_VALUE
SFNode field named occlusionTexture has default value null (Java syntax) or NULL (XML syntax). -
OCCLUSIONTEXTUREMAPPING_DEFAULT_VALUE
public static final java.lang.String OCCLUSIONTEXTUREMAPPING_DEFAULT_VALUESFString 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_VALUESFFloat 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_VALUESFFloat field named transparency has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_BASECOLOR
public static final java.lang.String fromField_BASECOLORfromField ROUTE name for SFColor field named baseColor.- See Also:
- Constant Field Values
-
toField_BASECOLOR
public static final java.lang.String toField_BASECOLORtoField ROUTE name for SFColor field named baseColor.- See Also:
- Constant Field Values
-
fromField_BASETEXTURE
public static final java.lang.String fromField_BASETEXTUREfromField ROUTE name for SFNode field named baseTexture.- See Also:
- Constant Field Values
-
toField_BASETEXTURE
public static final java.lang.String toField_BASETEXTUREtoField ROUTE name for SFNode field named baseTexture.- See Also:
- Constant Field Values
-
fromField_BASETEXTUREMAPPING
public static final java.lang.String fromField_BASETEXTUREMAPPINGfromField ROUTE name for SFString field named baseTextureMapping.- See Also:
- Constant Field Values
-
toField_BASETEXTUREMAPPING
public static final java.lang.String toField_BASETEXTUREMAPPINGtoField ROUTE name for SFString field named baseTextureMapping.- See Also:
- Constant Field Values
-
fromField_EMISSIVECOLOR
public static final java.lang.String fromField_EMISSIVECOLORfromField ROUTE name for SFColor field named emissiveColor.- See Also:
- Constant Field Values
-
toField_EMISSIVECOLOR
public static final java.lang.String toField_EMISSIVECOLORtoField ROUTE name for SFColor field named emissiveColor.- See Also:
- Constant Field Values
-
fromField_EMISSIVETEXTURE
public static final java.lang.String fromField_EMISSIVETEXTUREfromField ROUTE name for SFNode field named emissiveTexture.- See Also:
- Constant Field Values
-
toField_EMISSIVETEXTURE
public static final java.lang.String toField_EMISSIVETEXTUREtoField ROUTE name for SFNode field named emissiveTexture.- See Also:
- Constant Field Values
-
fromField_EMISSIVETEXTUREMAPPING
public static final java.lang.String fromField_EMISSIVETEXTUREMAPPINGfromField ROUTE name for SFString field named emissiveTextureMapping.- See Also:
- Constant Field Values
-
toField_EMISSIVETEXTUREMAPPING
public static final java.lang.String toField_EMISSIVETEXTUREMAPPINGtoField ROUTE name for SFString field named emissiveTextureMapping.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_METALLIC
public static final java.lang.String fromField_METALLICfromField ROUTE name for SFFloat field named metallic.- See Also:
- Constant Field Values
-
toField_METALLIC
public static final java.lang.String toField_METALLICtoField ROUTE name for SFFloat field named metallic.- See Also:
- Constant Field Values
-
fromField_METALLICROUGHNESSTEXTURE
public static final java.lang.String fromField_METALLICROUGHNESSTEXTUREfromField ROUTE name for SFNode field named metallicRoughnessTexture.- See Also:
- Constant Field Values
-
toField_METALLICROUGHNESSTEXTURE
public static final java.lang.String toField_METALLICROUGHNESSTEXTUREtoField ROUTE name for SFNode field named metallicRoughnessTexture.- See Also:
- Constant Field Values
-
fromField_METALLICROUGHNESSTEXTUREMAPPING
public static final java.lang.String fromField_METALLICROUGHNESSTEXTUREMAPPINGfromField ROUTE name for SFString field named metallicRoughnessTextureMapping.- See Also:
- Constant Field Values
-
toField_METALLICROUGHNESSTEXTUREMAPPING
public static final java.lang.String toField_METALLICROUGHNESSTEXTUREMAPPINGtoField ROUTE name for SFString field named metallicRoughnessTextureMapping.- See Also:
- Constant Field Values
-
fromField_NORMALSCALE
public static final java.lang.String fromField_NORMALSCALEfromField ROUTE name for SFFloat field named normalScale.- See Also:
- Constant Field Values
-
toField_NORMALSCALE
public static final java.lang.String toField_NORMALSCALEtoField ROUTE name for SFFloat field named normalScale.- See Also:
- Constant Field Values
-
fromField_NORMALTEXTURE
public static final java.lang.String fromField_NORMALTEXTUREfromField ROUTE name for SFNode field named normalTexture.- See Also:
- Constant Field Values
-
toField_NORMALTEXTURE
public static final java.lang.String toField_NORMALTEXTUREtoField ROUTE name for SFNode field named normalTexture.- See Also:
- Constant Field Values
-
fromField_NORMALTEXTUREMAPPING
public static final java.lang.String fromField_NORMALTEXTUREMAPPINGfromField ROUTE name for SFString field named normalTextureMapping.- See Also:
- Constant Field Values
-
toField_NORMALTEXTUREMAPPING
public static final java.lang.String toField_NORMALTEXTUREMAPPINGtoField ROUTE name for SFString field named normalTextureMapping.- See Also:
- Constant Field Values
-
fromField_OCCLUSIONSTRENGTH
public static final java.lang.String fromField_OCCLUSIONSTRENGTHfromField ROUTE name for SFFloat field named occlusionStrength.- See Also:
- Constant Field Values
-
toField_OCCLUSIONSTRENGTH
public static final java.lang.String toField_OCCLUSIONSTRENGTHtoField ROUTE name for SFFloat field named occlusionStrength.- See Also:
- Constant Field Values
-
fromField_OCCLUSIONTEXTURE
public static final java.lang.String fromField_OCCLUSIONTEXTUREfromField ROUTE name for SFNode field named occlusionTexture.- See Also:
- Constant Field Values
-
toField_OCCLUSIONTEXTURE
public static final java.lang.String toField_OCCLUSIONTEXTUREtoField ROUTE name for SFNode field named occlusionTexture.- See Also:
- Constant Field Values
-
fromField_OCCLUSIONTEXTUREMAPPING
public static final java.lang.String fromField_OCCLUSIONTEXTUREMAPPINGfromField ROUTE name for SFString field named occlusionTextureMapping.- See Also:
- Constant Field Values
-
toField_OCCLUSIONTEXTUREMAPPING
public static final java.lang.String toField_OCCLUSIONTEXTUREMAPPINGtoField ROUTE name for SFString field named occlusionTextureMapping.- See Also:
- Constant Field Values
-
fromField_ROUGHNESS
public static final java.lang.String fromField_ROUGHNESSfromField ROUTE name for SFFloat field named roughness.- See Also:
- Constant Field Values
-
toField_ROUGHNESS
public static final java.lang.String toField_ROUGHNESStoField ROUTE name for SFFloat field named roughness.- See Also:
- Constant Field Values
-
fromField_TRANSPARENCY
public static final java.lang.String fromField_TRANSPARENCYfromField ROUTE name for SFFloat field named transparency.- See Also:
- Constant Field Values
-
toField_TRANSPARENCY
public static final java.lang.String toField_TRANSPARENCYtoField 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(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: PhysicalMaterial- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the PhysicalMaterial element: Shape- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
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 interfacePhysicalMaterial
- Returns:
- value of baseColor field
-
setBaseColor
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 interfacePhysicalMaterial
- 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
Assign typed object value to SFColor baseColor field, similar tosetBaseColor(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
Assign values to SFColor baseColor field, similar tosetBaseColor(float[])
.- Parameters:
red
- first componentgreen
- second componentblue
- third component- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBaseColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBaseColor(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
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBaseColor(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
Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field baseTexture.- Specified by:
getBaseTexture
in interfacePhysicalMaterial
- 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
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 interfacePhysicalMaterial
- 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
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
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 java.lang.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 interfacePhysicalMaterial
- Returns:
- value of baseTextureMapping field
-
setBaseTextureMapping
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 interfacePhysicalMaterial
- 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
Assign typed object value to SFString baseTextureMapping field, similar tosetBaseTextureMapping(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 interfacePhysicalMaterial
- Specified by:
getEmissiveColor
in interfaceX3DOneSidedMaterialNode
- Returns:
- value of emissiveColor field
-
setEmissiveColor
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 interfacePhysicalMaterial
- Specified by:
setEmissiveColor
in interfaceX3DOneSidedMaterialNode
- 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
Assign typed object value to SFColor emissiveColor field, similar tosetEmissiveColor(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
Assign values to SFColor emissiveColor field, similar tosetEmissiveColor(float[])
.- Parameters:
red
- first componentgreen
- second componentblue
- third component- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEmissiveColor
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetEmissiveColor(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
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetEmissiveColor(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
Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field emissiveTexture.- Specified by:
getEmissiveTexture
in interfacePhysicalMaterial
- 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
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 interfacePhysicalMaterial
- 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
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
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 java.lang.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 interfacePhysicalMaterial
- Specified by:
getEmissiveTextureMapping
in interfaceX3DOneSidedMaterialNode
- Returns:
- value of emissiveTextureMapping field
-
setEmissiveTextureMapping
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 interfacePhysicalMaterial
- Specified by:
setEmissiveTextureMapping
in interfaceX3DOneSidedMaterialNode
- 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
Assign typed object value to SFString emissiveTextureMapping field, similar tosetEmissiveTextureMapping(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
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
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
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
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfacePhysicalMaterial
- Specified by:
getMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
getMetadata
in interfaceX3DMaterialNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DOneSidedMaterialNode
- 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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfacePhysicalMaterial
- Specified by:
setMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
setMetadata
in interfaceX3DMaterialNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DOneSidedMaterialNode
- Specified by:
setMetadata
in classX3DConcreteNode
- 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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
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
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
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 interfacePhysicalMaterial
- Returns:
- value of metallic field
-
setMetallic
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 interfacePhysicalMaterial
- 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
Assign typed object value to SFFloat metallic field, similar tosetMetallic(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
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMetallic(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
Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field metallicRoughnessTexture.- Specified by:
getMetallicRoughnessTexture
in interfacePhysicalMaterial
- Returns:
- value of metallicRoughnessTexture field
- See Also:
getMetallicRoughnessTextureProtoInstance()
-
setMetallicRoughnessTexture
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 interfacePhysicalMaterial
- 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(ProtoInstance)
-
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
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 java.lang.String getMetallicRoughnessTextureMapping()Provide String value from inputOutput SFString field named metallicRoughnessTextureMapping.- Specified by:
getMetallicRoughnessTextureMapping
in interfacePhysicalMaterial
- Returns:
- value of metallicRoughnessTextureMapping field
-
setMetallicRoughnessTextureMapping
Accessor method to assign String value to inputOutput SFString field named metallicRoughnessTextureMapping.- Specified by:
setMetallicRoughnessTextureMapping
in interfacePhysicalMaterial
- 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
Assign typed object value to SFString metallicRoughnessTextureMapping field, similar tosetMetallicRoughnessTextureMapping(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 interfacePhysicalMaterial
- Specified by:
getNormalScale
in interfaceX3DOneSidedMaterialNode
- Returns:
- value of normalScale field
-
setNormalScale
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 interfacePhysicalMaterial
- Specified by:
setNormalScale
in interfaceX3DOneSidedMaterialNode
- 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
Assign typed object value to SFFloat normalScale field, similar tosetNormalScale(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
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetNormalScale(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
Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field normalTexture.- Specified by:
getNormalTexture
in interfacePhysicalMaterial
- 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
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 interfacePhysicalMaterial
- 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
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
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 java.lang.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 interfacePhysicalMaterial
- Specified by:
getNormalTextureMapping
in interfaceX3DOneSidedMaterialNode
- Returns:
- value of normalTextureMapping field
-
setNormalTextureMapping
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 interfacePhysicalMaterial
- Specified by:
setNormalTextureMapping
in interfaceX3DOneSidedMaterialNode
- 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
Assign typed object value to SFString normalTextureMapping field, similar tosetNormalTextureMapping(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 interfacePhysicalMaterial
- Returns:
- value of occlusionStrength field
-
setOcclusionStrength
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 interfacePhysicalMaterial
- 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
Assign typed object value to SFFloat occlusionStrength field, similar tosetOcclusionStrength(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
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetOcclusionStrength(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
Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field occlusionTexture.- Specified by:
getOcclusionTexture
in interfacePhysicalMaterial
- 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
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 interfacePhysicalMaterial
- 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
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
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 java.lang.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 interfacePhysicalMaterial
- Returns:
- value of occlusionTextureMapping field
-
setOcclusionTextureMapping
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 interfacePhysicalMaterial
- 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
Assign typed object value to SFString occlusionTextureMapping field, similar tosetOcclusionTextureMapping(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 interfacePhysicalMaterial
- Returns:
- value of roughness field
-
setRoughness
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 interfacePhysicalMaterial
- 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
Assign typed object value to SFFloat roughness field, similar tosetRoughness(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
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetRoughness(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 interfacePhysicalMaterial
- Returns:
- value of transparency field
-
setTransparency
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 interfacePhysicalMaterial
- 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
Assign typed object value to SFFloat transparency field, similar tosetTransparency(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
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetTransparency(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 java.lang.String getDEF()Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.String getUSE()Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Parameters:
DEFnode
- must have a DEF value defined- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
PhysicalMaterial
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.String toStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
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 java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
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 java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
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
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
findElementByNameValue(String, String)
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
findNodeByDEF(String)
-
validate
public java.lang.String validate()Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-