Class ShadedVolumeStyleObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.VolumeRendering.ShadedVolumeStyleObject
- All Implemented Interfaces:
X3DNode
,ShadedVolumeStyle
,X3DComposableVolumeRenderStyleNode
,X3DVolumeRenderStyleNode
public class ShadedVolumeStyleObject extends X3DConcreteNode implements ShadedVolumeStyle
All fields fully supported except shadows supported with at least Phong shading at level 3. All fields fully supported with at least Phong shading and Henyey-Greenstein phase function, shadows fully supported at level 4.
X3D node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] ShadedVolumeStyle applies Blinn-Phong illumination model to volume rendering.
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 3.3 or later) [X3DComposableVolumeRenderStyleNode] ShadedVolumeStyle applies Blinn-Phong illumination model to volume rendering.
- Hint: ShadedVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals' and a single Material node.
- Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='3'/> or level='4' to include shadows.
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 java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the ShadedVolumeStyle element: VolumeRenderingstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static boolean
ENABLED_DEFAULT_VALUE
SFBool field named enabled has default value true (Java syntax) or true (XML syntax).static java.lang.String
fromField_ENABLED
fromField ROUTE name for SFBool field named enabled.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_LIGHTING
fromField ROUTE name for SFBool field named lighting.static java.lang.String
fromField_MATERIAL
fromField ROUTE name for SFNode field named material.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_SHADOWS
fromField ROUTE name for SFBool field named shadows.static java.lang.String
fromField_SURFACENORMALS
fromField ROUTE name for SFNode field named surfaceNormals.static ISObject
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 VolumeRendering component level for this element: 3static boolean
LIGHTING_DEFAULT_VALUE
SFBool field named lighting has default value false (Java syntax) or false (XML syntax).static X3DMaterialNode
MATERIAL_DEFAULT_VALUE
SFNode field named material has default value null (Java syntax) or NULL (XML syntax).static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: ShadedVolumeStyle.static java.lang.String
PHASEFUNCTION_DEFAULT_VALUE
SFString field named phaseFunction has default value "Henyey-Greenstein" (Java syntax) or Henyey-Greenstein (XML syntax).static java.lang.String
PHASEFUNCTION_HENYEY_GREENSTEIN
Tooltip: Henyey-Greenstein phase function for scattering model.static java.lang.String
PHASEFUNCTION_NONE
Tooltip: no scattering.static boolean
SHADOWS_DEFAULT_VALUE
SFBool field named shadows has default value false (Java syntax) or false (XML syntax).static X3DTexture3DNode
SURFACENORMALS_DEFAULT_VALUE
SFNode field named surfaceNormals has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
toField_ENABLED
toField ROUTE name for SFBool field named enabled.static java.lang.String
toField_LIGHTING
toField ROUTE name for SFBool field named lighting.static java.lang.String
toField_MATERIAL
toField ROUTE name for SFNode field named material.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_SHADOWS
toField ROUTE name for SFBool field named shadows.static java.lang.String
toField_SURFACENORMALS
toField ROUTE name for SFNode field named surfaceNormals.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 ShadedVolumeStyleObject()
Constructor for ShadedVolumeStyleObject to initialize member variables with default values.ShadedVolumeStyleObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description ShadedVolumeStyleObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.ShadedVolumeStyleObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.ShadedVolumeStyleObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.ShadedVolumeStyleObject
clearIS()
Utility method to clear SFNode value of IS field.ShadedVolumeStyleObject
clearMaterial()
Utility method to clear SFNode value of material field.ShadedVolumeStyleObject
clearMetadata()
Utility method to clear SFNode value of metadata field.ShadedVolumeStyleObject
clearSurfaceNormals()
Utility method to clear SFNode value of surfaceNormals 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.java.lang.String
getComponent()
Defines X3D component for the ShadedVolumeStyle element: VolumeRenderingint
getComponentLevel()
Provides default X3D component level for this element: 3java.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: ShadedVolumeStyleboolean
getEnabled()
Provide boolean value from inputOutput SFBool field named enabled.java.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.boolean
getLighting()
Provide boolean value from inputOutput SFBool field named lighting.X3DMaterialNode
getMaterial()
Provide X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.java.lang.String
getPhaseFunction()
Provide String enumeration value (baseType SFString) ["Henyey-Greenstein" | "NONE" | 'etc.'] from initializeOnly SFString field named phaseFunction.boolean
getShadows()
Provide boolean value from inputOutput SFBool field named shadows.X3DTexture3DNode
getSurfaceNormals()
Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.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
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
hasMaterial()
Indicate whether an object is available for inputOutput SFNode field material.boolean
hasMetadata()
Indicate whether an object is available for inputOutput SFNode field metadata.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
hasSurfaceNormals()
Indicate whether an object is available for inputOutput SFNode field surfaceNormals.void
initialize()
Initialize all member variables to default values.ShadedVolumeStyleObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.ShadedVolumeStyleObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.ShadedVolumeStyleObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.ShadedVolumeStyleObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.ShadedVolumeStyleObject
setEnabled(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named enabled.ShadedVolumeStyleObject
setEnabled(SFBoolObject newValue)
Assign typed object value to SFBool enabled field, similar tosetEnabled(boolean)
.ShadedVolumeStyleObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.ShadedVolumeStyleObject
setLighting(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named lighting.ShadedVolumeStyleObject
setLighting(SFBoolObject newValue)
Assign typed object value to SFBool lighting field, similar tosetLighting(boolean)
.ShadedVolumeStyleObject
setMaterial(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field material.ShadedVolumeStyleObject
setMaterial(X3DMaterialNode newValue)
Accessor method to assign X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.ShadedVolumeStyleObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.ShadedVolumeStyleObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.ShadedVolumeStyleObject
setPhaseFunction(java.lang.String newValue)
Accessor method to assign String enumeration value ("Henyey-Greenstein" | "NONE") to initializeOnly SFString field named phaseFunction.ShadedVolumeStyleObject
setPhaseFunction(SFStringObject newValue)
Assign typed object value to SFString phaseFunction field, similar tosetPhaseFunction(String)
.ShadedVolumeStyleObject
setShadows(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named shadows.ShadedVolumeStyleObject
setShadows(SFBoolObject newValue)
Assign typed object value to SFBool shadows field, similar tosetShadows(boolean)
.ShadedVolumeStyleObject
setSurfaceNormals(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field surfaceNormals.ShadedVolumeStyleObject
setSurfaceNormals(X3DTexture3DNode newValue)
Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field surfaceNormals.ShadedVolumeStyleObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.ShadedVolumeStyleObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.ShadedVolumeStyleObject
setUSE(ShadedVolumeStyleObject 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
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
PHASEFUNCTION_HENYEY_GREENSTEIN
public static final java.lang.String PHASEFUNCTION_HENYEY_GREENSTEINTooltip: Henyey-Greenstein phase function for scattering model. SFString field named phaseFunction with X3DUOM simpleType phaseFunctionValues and with X3DUOM baseType SFString can equal this value "Henyey-Greenstein" (Java syntax) or Henyey-Greenstein (XML syntax). -
PHASEFUNCTION_NONE
public static final java.lang.String PHASEFUNCTION_NONETooltip: no scattering. SFString field named phaseFunction with X3DUOM simpleType phaseFunctionValues and with X3DUOM baseType SFString can equal this value "NONE" (Java syntax) or NONE (XML syntax). -
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: ShadedVolumeStyle.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the ShadedVolumeStyle element: VolumeRendering- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D VolumeRendering component level for this element: 3- See Also:
- Constant Field Values
-
ENABLED_DEFAULT_VALUE
public static final boolean ENABLED_DEFAULT_VALUESFBool field named enabled has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
LIGHTING_DEFAULT_VALUE
public static final boolean LIGHTING_DEFAULT_VALUESFBool field named lighting has default value false (Java syntax) or false (XML syntax).- See Also:
- Constant Field Values
-
MATERIAL_DEFAULT_VALUE
SFNode field named material 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). -
PHASEFUNCTION_DEFAULT_VALUE
public static final java.lang.String PHASEFUNCTION_DEFAULT_VALUESFString field named phaseFunction has default value "Henyey-Greenstein" (Java syntax) or Henyey-Greenstein (XML syntax).- See Also:
- Constant Field Values
-
SHADOWS_DEFAULT_VALUE
public static final boolean SHADOWS_DEFAULT_VALUESFBool field named shadows has default value false (Java syntax) or false (XML syntax).- See Also:
- Constant Field Values
-
SURFACENORMALS_DEFAULT_VALUE
SFNode field named surfaceNormals has default value null (Java syntax) or NULL (XML syntax). -
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_ENABLED
public static final java.lang.String fromField_ENABLEDfromField ROUTE name for SFBool field named enabled.- See Also:
- Constant Field Values
-
toField_ENABLED
public static final java.lang.String toField_ENABLEDtoField ROUTE name for SFBool field named enabled.- 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_LIGHTING
public static final java.lang.String fromField_LIGHTINGfromField ROUTE name for SFBool field named lighting.- See Also:
- Constant Field Values
-
toField_LIGHTING
public static final java.lang.String toField_LIGHTINGtoField ROUTE name for SFBool field named lighting.- See Also:
- Constant Field Values
-
fromField_MATERIAL
public static final java.lang.String fromField_MATERIALfromField ROUTE name for SFNode field named material.- See Also:
- Constant Field Values
-
toField_MATERIAL
public static final java.lang.String toField_MATERIALtoField ROUTE name for SFNode field named material.- 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_SHADOWS
public static final java.lang.String fromField_SHADOWSfromField ROUTE name for SFBool field named shadows.- See Also:
- Constant Field Values
-
toField_SHADOWS
public static final java.lang.String toField_SHADOWStoField ROUTE name for SFBool field named shadows.- See Also:
- Constant Field Values
-
fromField_SURFACENORMALS
public static final java.lang.String fromField_SURFACENORMALSfromField ROUTE name for SFNode field named surfaceNormals.- See Also:
- Constant Field Values
-
toField_SURFACENORMALS
public static final java.lang.String toField_SURFACENORMALStoField ROUTE name for SFNode field named surfaceNormals.- See Also:
- Constant Field Values
-
-
Constructor Details
-
ShadedVolumeStyleObject
public ShadedVolumeStyleObject()Constructor for ShadedVolumeStyleObject to initialize member variables with default values. -
ShadedVolumeStyleObject
public ShadedVolumeStyleObject(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: ShadedVolumeStyle- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the ShadedVolumeStyle element: VolumeRendering- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 3- 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
-
getEnabled
public boolean getEnabled()Provide boolean value from inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
getEnabled
in interfaceShadedVolumeStyle
- Specified by:
getEnabled
in interfaceX3DComposableVolumeRenderStyleNode
- Specified by:
getEnabled
in interfaceX3DVolumeRenderStyleNode
- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
setEnabled
in interfaceShadedVolumeStyle
- Specified by:
setEnabled
in interfaceX3DComposableVolumeRenderStyleNode
- Specified by:
setEnabled
in interfaceX3DVolumeRenderStyleNode
- Parameters:
newValue
- is new value for the enabled field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEnabled
Assign typed object value to SFBool enabled field, similar tosetEnabled(boolean)
.- Parameters:
newValue
- is new value for the enabled field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject 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 ISObject 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:
ShadedVolumeStyleObject
- 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:
ShadedVolumeStyleObject
- 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()
-
getLighting
public boolean getLighting()Provide boolean value from inputOutput SFBool field named lighting.
Tooltip: Whether rendering calculates and applies shading effects to visual output. *- Specified by:
getLighting
in interfaceShadedVolumeStyle
- Returns:
- value of lighting field
-
setLighting
Accessor method to assign boolean value to inputOutput SFBool field named lighting.
Tooltip: Whether rendering calculates and applies shading effects to visual output. *- Specified by:
setLighting
in interfaceShadedVolumeStyle
- Parameters:
newValue
- is new value for the lighting field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setLighting
Assign typed object value to SFBool lighting field, similar tosetLighting(boolean)
.- Parameters:
newValue
- is new value for the lighting field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMaterial
Provide X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.- Specified by:
getMaterial
in interfaceShadedVolumeStyle
- Returns:
- value of material field
- See Also:
getMaterialProtoInstance()
-
setMaterial
Accessor method to assign X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.- Specified by:
setMaterial
in interfaceShadedVolumeStyle
- Parameters:
newValue
- is new value for the material field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMaterial(ProtoInstanceObject)
-
clearMaterial
Utility method to clear SFNode value of material field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMaterial
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field material.- Parameters:
newValue
- is new value for the material field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMaterial(X3DMaterialNode)
-
hasMaterial
public boolean hasMaterial()Indicate whether an object is available for inputOutput SFNode field material.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getMaterial()
,getMaterialProtoInstance()
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceShadedVolumeStyle
- Specified by:
getMetadata
in interfaceX3DComposableVolumeRenderStyleNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DVolumeRenderStyleNode
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceShadedVolumeStyle
- Specified by:
setMetadata
in interfaceX3DComposableVolumeRenderStyleNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DVolumeRenderStyleNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
ShadedVolumeStyleObject
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
ShadedVolumeStyleObject
- 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:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(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
-
getPhaseFunction
public java.lang.String getPhaseFunction()Provide String enumeration value (baseType SFString) ["Henyey-Greenstein" | "NONE" | 'etc.'] from initializeOnly SFString field named phaseFunction.
Tooltip: define scattering model for implementations using global illumination (NONE or Henyey-Greenstein phase function).#10;- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
Available enumeration values for string comparison:HENYEY_GREENSTEIN
,NONE
.- Specified by:
getPhaseFunction
in interfaceShadedVolumeStyle
- Returns:
- value of phaseFunction field
-
setPhaseFunction
Accessor method to assign String enumeration value ("Henyey-Greenstein" | "NONE") to initializeOnly SFString field named phaseFunction.
Hint: authors have option to choose from an extendible list of predefined enumeration values (HENYEY_GREENSTEIN
,NONE
).
Tooltip: define scattering model for implementations using global illumination (NONE or Henyey-Greenstein phase function).#10;- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Specified by:
setPhaseFunction
in interfaceShadedVolumeStyle
- Parameters:
newValue
- is new value for the phaseFunction field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPhaseFunction
Assign typed object value to SFString phaseFunction field, similar tosetPhaseFunction(String)
.- Parameters:
newValue
- is new value for the phaseFunction field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getShadows
public boolean getShadows()Provide boolean value from inputOutput SFBool field named shadows.
Tooltip: Whether rendering calculates and applies shadows to visual output (using global illumination model). *- Specified by:
getShadows
in interfaceShadedVolumeStyle
- Returns:
- value of shadows field
-
setShadows
Accessor method to assign boolean value to inputOutput SFBool field named shadows.
Tooltip: Whether rendering calculates and applies shadows to visual output (using global illumination model). *- Specified by:
setShadows
in interfaceShadedVolumeStyle
- Parameters:
newValue
- is new value for the shadows field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setShadows
Assign typed object value to SFBool shadows field, similar tosetShadows(boolean)
.- Parameters:
newValue
- is new value for the shadows field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSurfaceNormals
Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.- Specified by:
getSurfaceNormals
in interfaceShadedVolumeStyle
- Returns:
- value of surfaceNormals field
- See Also:
getSurfaceNormalsProtoInstance()
-
setSurfaceNormals
Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field surfaceNormals.- Specified by:
setSurfaceNormals
in interfaceShadedVolumeStyle
- Parameters:
newValue
- is new value for the surfaceNormals field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setSurfaceNormals(ProtoInstanceObject)
-
clearSurfaceNormals
Utility method to clear SFNode value of surfaceNormals field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setSurfaceNormals
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field surfaceNormals.- Parameters:
newValue
- is new value for the surfaceNormals field.- Returns:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setSurfaceNormals(X3DTexture3DNode)
-
hasSurfaceNormals
public boolean hasSurfaceNormals()Indicate whether an object is available for inputOutput SFNode field surfaceNormals.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getSurfaceNormals()
,getSurfaceNormalsProtoInstance()
-
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:
ShadedVolumeStyleObject
- 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:
ShadedVolumeStyleObject
- 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:
ShadedVolumeStyleObject
- 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:
ShadedVolumeStyleObject
- 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 CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- 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 CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- 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:
ShadedVolumeStyleObject
- 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:
ShadedVolumeStyleObject
- 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:
ShadedVolumeStyleObject
- 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:
ShadedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
ShadedVolumeStyleObject
- 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:
ShadedVolumeStyleObject
- 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:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.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:
X3DObject.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:
X3DObject.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
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)
-