Class BlendedVolumeStyleObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.VolumeRendering.BlendedVolumeStyleObject
- All Implemented Interfaces:
X3DNode
,BlendedVolumeStyle
,X3DComposableVolumeRenderStyleNode
,X3DVolumeRenderStyleNode
public class BlendedVolumeStyleObject extends X3DConcreteNode implements BlendedVolumeStyle
BlendedVolumeStyle combines rendering of two voxel data sets into one by blending voxel values.
X3D node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] BlendedVolumeStyle combines rendering of two voxel data sets into one by blending voxel values.
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] BlendedVolumeStyle combines rendering of two voxel data sets into one by blending voxel values.
- Hint: BlendedVolumeStyle can contain just one each of following: VolumeStyle node with containerField='renderStyle', Texture3D node with containerField='voxels', Texture2D node with containerField='weightTransferFunction1' and Texture2D node with containerField='weightTransferFunction2'.
- Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='3'/>
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 BlendedVolumeStyle 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_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_RENDERSTYLE
fromField ROUTE name for SFNode field named renderStyle.static java.lang.String
fromField_VOXELS
fromField ROUTE name for SFNode field named voxels.static java.lang.String
fromField_WEIGHTCONSTANT1
fromField ROUTE name for SFFloat field named weightConstant1.static java.lang.String
fromField_WEIGHTCONSTANT2
fromField ROUTE name for SFFloat field named weightConstant2.static java.lang.String
fromField_WEIGHTFUNCTION1
fromField ROUTE name for SFString field named weightFunction1.static java.lang.String
fromField_WEIGHTFUNCTION2
fromField ROUTE name for SFString field named weightFunction2.static java.lang.String
fromField_WEIGHTTRANSFERFUNCTION1
fromField ROUTE name for SFNode field named weightTransferFunction1.static java.lang.String
fromField_WEIGHTTRANSFERFUNCTION2
fromField ROUTE name for SFNode field named weightTransferFunction2.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 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: BlendedVolumeStyle.static X3DComposableVolumeRenderStyleNode
RENDERSTYLE_DEFAULT_VALUE
SFNode field named renderStyle 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_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_RENDERSTYLE
toField ROUTE name for SFNode field named renderStyle.static java.lang.String
toField_VOXELS
toField ROUTE name for SFNode field named voxels.static java.lang.String
toField_WEIGHTCONSTANT1
toField ROUTE name for SFFloat field named weightConstant1.static java.lang.String
toField_WEIGHTCONSTANT2
toField ROUTE name for SFFloat field named weightConstant2.static java.lang.String
toField_WEIGHTFUNCTION1
toField ROUTE name for SFString field named weightFunction1.static java.lang.String
toField_WEIGHTFUNCTION2
toField ROUTE name for SFString field named weightFunction2.static java.lang.String
toField_WEIGHTTRANSFERFUNCTION1
toField ROUTE name for SFNode field named weightTransferFunction1.static java.lang.String
toField_WEIGHTTRANSFERFUNCTION2
toField ROUTE name for SFNode field named weightTransferFunction2.static X3DTexture3DNode
VOXELS_DEFAULT_VALUE
SFNode field named voxels has default value null (Java syntax) or NULL (XML syntax).static float
WEIGHTCONSTANT1_DEFAULT_VALUE
SFFloat field named weightConstant1 has default value 0.5f (Java syntax) or 0.5 (XML syntax).static float
WEIGHTCONSTANT2_DEFAULT_VALUE
SFFloat field named weightConstant2 has default value 0.5f (Java syntax) or 0.5 (XML syntax).static java.lang.String
WEIGHTFUNCTION1_ALPHA1
Tooltip: Use O_v.static java.lang.String
WEIGHTFUNCTION1_ALPHA2
Tooltip: Use O_blend.static java.lang.String
WEIGHTFUNCTION1_CONSTANT
Tooltip: Use weightConstant1.static java.lang.String
WEIGHTFUNCTION1_DEFAULT_VALUE
SFString field named weightFunction1 has default value "CONSTANT" (Java syntax) or CONSTANT (XML syntax).static java.lang.String
WEIGHTFUNCTION1_ONE_MINUS_ALPHA1
Tooltip: Use 1 - O_v.static java.lang.String
WEIGHTFUNCTION1_ONE_MINUS_ALPHA2
Tooltip: Use 1 - O_blend.static java.lang.String
WEIGHTFUNCTION1_TABLE
Tooltip: Use table lookup value.static java.lang.String
WEIGHTFUNCTION2_ALPHA1
Tooltip: Use O_v.static java.lang.String
WEIGHTFUNCTION2_ALPHA2
Tooltip: Use O_blend.static java.lang.String
WEIGHTFUNCTION2_CONSTANT
Tooltip: Use weightConstant1.static java.lang.String
WEIGHTFUNCTION2_DEFAULT_VALUE
SFString field named weightFunction2 has default value "CONSTANT" (Java syntax) or CONSTANT (XML syntax).static java.lang.String
WEIGHTFUNCTION2_ONE_MINUS_ALPHA1
Tooltip: Use 1 - O_v.static java.lang.String
WEIGHTFUNCTION2_ONE_MINUS_ALPHA2
Tooltip: Use 1 - O_blend.static java.lang.String
WEIGHTFUNCTION2_TABLE
Tooltip: Use table lookup value.static X3DTexture2DNode
WEIGHTTRANSFERFUNCTION1_DEFAULT_VALUE
SFNode field named weightTransferFunction1 has default value null (Java syntax) or NULL (XML syntax).static X3DTexture2DNode
WEIGHTTRANSFERFUNCTION2_DEFAULT_VALUE
SFNode field named weightTransferFunction2 has default value null (Java syntax) or NULL (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 BlendedVolumeStyleObject()
Constructor for BlendedVolumeStyleObject to initialize member variables with default values.BlendedVolumeStyleObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description BlendedVolumeStyleObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.BlendedVolumeStyleObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.BlendedVolumeStyleObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.BlendedVolumeStyleObject
clearIS()
Utility method to clear SFNode value of IS field.BlendedVolumeStyleObject
clearMetadata()
Utility method to clear SFNode value of metadata field.BlendedVolumeStyleObject
clearRenderStyle()
Utility method to clear SFNode value of renderStyle field.BlendedVolumeStyleObject
clearVoxels()
Utility method to clear SFNode value of voxels field.BlendedVolumeStyleObject
clearWeightTransferFunction1()
Utility method to clear SFNode value of weightTransferFunction1 field.BlendedVolumeStyleObject
clearWeightTransferFunction2()
Utility method to clear SFNode value of weightTransferFunction2 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 BlendedVolumeStyle 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: BlendedVolumeStyleboolean
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.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.X3DComposableVolumeRenderStyleNode
getRenderStyle()
Provide X3DComposableVolumeRenderStyleNode instance (using a properly typed node) from inputOutput SFNode field renderStyle.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.X3DTexture3DNode
getVoxels()
Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.float
getWeightConstant1()
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant1.float
getWeightConstant2()
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant2.java.lang.String
getWeightFunction1()
Provide String enumeration value (baseType xs:NMTOKEN) ["CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE"] from inputOutput SFString field named weightFunction1.java.lang.String
getWeightFunction2()
Provide String enumeration value (baseType xs:NMTOKEN) ["CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE"] from inputOutput SFString field named weightFunction2.X3DTexture2DNode
getWeightTransferFunction1()
Provide X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction1.X3DTexture2DNode
getWeightTransferFunction2()
Provide X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction2.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
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
hasRenderStyle()
Indicate whether an object is available for inputOutput SFNode field renderStyle.boolean
hasVoxels()
Indicate whether an object is available for inputOutput SFNode field voxels.boolean
hasWeightTransferFunction1()
Indicate whether an object is available for inputOutput SFNode field weightTransferFunction1.boolean
hasWeightTransferFunction2()
Indicate whether an object is available for inputOutput SFNode field weightTransferFunction2.void
initialize()
Initialize all member variables to default values.BlendedVolumeStyleObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.BlendedVolumeStyleObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.BlendedVolumeStyleObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.BlendedVolumeStyleObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.BlendedVolumeStyleObject
setEnabled(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named enabled.BlendedVolumeStyleObject
setEnabled(SFBoolObject newValue)
Assign typed object value to SFBool enabled field, similar tosetEnabled(boolean)
.BlendedVolumeStyleObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.BlendedVolumeStyleObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.BlendedVolumeStyleObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.BlendedVolumeStyleObject
setRenderStyle(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field renderStyle.BlendedVolumeStyleObject
setRenderStyle(X3DComposableVolumeRenderStyleNode newValue)
Accessor method to assign X3DComposableVolumeRenderStyleNode instance (using a properly typed node) to inputOutput SFNode field renderStyle.BlendedVolumeStyleObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.BlendedVolumeStyleObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.BlendedVolumeStyleObject
setUSE(BlendedVolumeStyleObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.BlendedVolumeStyleObject
setVoxels(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field voxels.BlendedVolumeStyleObject
setVoxels(X3DTexture3DNode newValue)
Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.BlendedVolumeStyleObject
setWeightConstant1(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetWeightConstant1(float)
.BlendedVolumeStyleObject
setWeightConstant1(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named weightConstant1.BlendedVolumeStyleObject
setWeightConstant1(SFFloatObject newValue)
Assign typed object value to SFFloat weightConstant1 field, similar tosetWeightConstant1(float)
.BlendedVolumeStyleObject
setWeightConstant2(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetWeightConstant2(float)
.BlendedVolumeStyleObject
setWeightConstant2(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named weightConstant2.BlendedVolumeStyleObject
setWeightConstant2(SFFloatObject newValue)
Assign typed object value to SFFloat weightConstant2 field, similar tosetWeightConstant2(float)
.BlendedVolumeStyleObject
setWeightFunction1(java.lang.String newValue)
Accessor method to assign String enumeration value ("CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE") to inputOutput SFString field named weightFunction1.BlendedVolumeStyleObject
setWeightFunction1(SFStringObject newValue)
Assign typed object value to SFString weightFunction1 field, similar tosetWeightFunction1(String)
.BlendedVolumeStyleObject
setWeightFunction2(java.lang.String newValue)
Accessor method to assign String enumeration value ("CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE") to inputOutput SFString field named weightFunction2.BlendedVolumeStyleObject
setWeightFunction2(SFStringObject newValue)
Assign typed object value to SFString weightFunction2 field, similar tosetWeightFunction2(String)
.BlendedVolumeStyleObject
setWeightTransferFunction1(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field weightTransferFunction1.BlendedVolumeStyleObject
setWeightTransferFunction1(X3DTexture2DNode newValue)
Accessor method to assign X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction1.BlendedVolumeStyleObject
setWeightTransferFunction2(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field weightTransferFunction2.BlendedVolumeStyleObject
setWeightTransferFunction2(X3DTexture2DNode newValue)
Accessor method to assign X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction2.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
-
WEIGHTFUNCTION1_CONSTANT
public static final java.lang.String WEIGHTFUNCTION1_CONSTANTTooltip: Use weightConstant1. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CONSTANT" (Java syntax) or CONSTANT (XML syntax). -
WEIGHTFUNCTION1_ALPHA1
public static final java.lang.String WEIGHTFUNCTION1_ALPHA1Tooltip: Use O_v. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ALPHA1" (Java syntax) or ALPHA1 (XML syntax). -
WEIGHTFUNCTION1_ALPHA2
public static final java.lang.String WEIGHTFUNCTION1_ALPHA2Tooltip: Use O_blend. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ALPHA2" (Java syntax) or ALPHA2 (XML syntax). -
WEIGHTFUNCTION1_ONE_MINUS_ALPHA1
public static final java.lang.String WEIGHTFUNCTION1_ONE_MINUS_ALPHA1Tooltip: Use 1 - O_v. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ONE_MINUS_ALPHA1" (Java syntax) or ONE_MINUS_ALPHA1 (XML syntax). -
WEIGHTFUNCTION1_ONE_MINUS_ALPHA2
public static final java.lang.String WEIGHTFUNCTION1_ONE_MINUS_ALPHA2Tooltip: Use 1 - O_blend. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ONE_MINUS_ALPHA2" (Java syntax) or ONE_MINUS_ALPHA2 (XML syntax). -
WEIGHTFUNCTION1_TABLE
public static final java.lang.String WEIGHTFUNCTION1_TABLETooltip: Use table lookup value. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "TABLE" (Java syntax) or TABLE (XML syntax). -
WEIGHTFUNCTION2_CONSTANT
public static final java.lang.String WEIGHTFUNCTION2_CONSTANTTooltip: Use weightConstant1. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CONSTANT" (Java syntax) or CONSTANT (XML syntax). -
WEIGHTFUNCTION2_ALPHA1
public static final java.lang.String WEIGHTFUNCTION2_ALPHA1Tooltip: Use O_v. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ALPHA1" (Java syntax) or ALPHA1 (XML syntax). -
WEIGHTFUNCTION2_ALPHA2
public static final java.lang.String WEIGHTFUNCTION2_ALPHA2Tooltip: Use O_blend. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ALPHA2" (Java syntax) or ALPHA2 (XML syntax). -
WEIGHTFUNCTION2_ONE_MINUS_ALPHA1
public static final java.lang.String WEIGHTFUNCTION2_ONE_MINUS_ALPHA1Tooltip: Use 1 - O_v. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ONE_MINUS_ALPHA1" (Java syntax) or ONE_MINUS_ALPHA1 (XML syntax). -
WEIGHTFUNCTION2_ONE_MINUS_ALPHA2
public static final java.lang.String WEIGHTFUNCTION2_ONE_MINUS_ALPHA2Tooltip: Use 1 - O_blend. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ONE_MINUS_ALPHA2" (Java syntax) or ONE_MINUS_ALPHA2 (XML syntax). -
WEIGHTFUNCTION2_TABLE
public static final java.lang.String WEIGHTFUNCTION2_TABLETooltip: Use table lookup value. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "TABLE" (Java syntax) or TABLE (XML syntax). -
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: BlendedVolumeStyle.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the BlendedVolumeStyle 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). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
RENDERSTYLE_DEFAULT_VALUE
SFNode field named renderStyle has default value null (Java syntax) or NULL (XML syntax). -
VOXELS_DEFAULT_VALUE
SFNode field named voxels has default value null (Java syntax) or NULL (XML syntax). -
WEIGHTCONSTANT1_DEFAULT_VALUE
public static final float WEIGHTCONSTANT1_DEFAULT_VALUESFFloat field named weightConstant1 has default value 0.5f (Java syntax) or 0.5 (XML syntax).- See Also:
- Constant Field Values
-
WEIGHTCONSTANT2_DEFAULT_VALUE
public static final float WEIGHTCONSTANT2_DEFAULT_VALUESFFloat field named weightConstant2 has default value 0.5f (Java syntax) or 0.5 (XML syntax).- See Also:
- Constant Field Values
-
WEIGHTFUNCTION1_DEFAULT_VALUE
public static final java.lang.String WEIGHTFUNCTION1_DEFAULT_VALUESFString field named weightFunction1 has default value "CONSTANT" (Java syntax) or CONSTANT (XML syntax).- See Also:
- Constant Field Values
-
WEIGHTFUNCTION2_DEFAULT_VALUE
public static final java.lang.String WEIGHTFUNCTION2_DEFAULT_VALUESFString field named weightFunction2 has default value "CONSTANT" (Java syntax) or CONSTANT (XML syntax).- See Also:
- Constant Field Values
-
WEIGHTTRANSFERFUNCTION1_DEFAULT_VALUE
SFNode field named weightTransferFunction1 has default value null (Java syntax) or NULL (XML syntax). -
WEIGHTTRANSFERFUNCTION2_DEFAULT_VALUE
SFNode field named weightTransferFunction2 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_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_RENDERSTYLE
public static final java.lang.String fromField_RENDERSTYLEfromField ROUTE name for SFNode field named renderStyle.- See Also:
- Constant Field Values
-
toField_RENDERSTYLE
public static final java.lang.String toField_RENDERSTYLEtoField ROUTE name for SFNode field named renderStyle.- See Also:
- Constant Field Values
-
fromField_VOXELS
public static final java.lang.String fromField_VOXELSfromField ROUTE name for SFNode field named voxels.- See Also:
- Constant Field Values
-
toField_VOXELS
public static final java.lang.String toField_VOXELStoField ROUTE name for SFNode field named voxels.- See Also:
- Constant Field Values
-
fromField_WEIGHTCONSTANT1
public static final java.lang.String fromField_WEIGHTCONSTANT1fromField ROUTE name for SFFloat field named weightConstant1.- See Also:
- Constant Field Values
-
toField_WEIGHTCONSTANT1
public static final java.lang.String toField_WEIGHTCONSTANT1toField ROUTE name for SFFloat field named weightConstant1.- See Also:
- Constant Field Values
-
fromField_WEIGHTCONSTANT2
public static final java.lang.String fromField_WEIGHTCONSTANT2fromField ROUTE name for SFFloat field named weightConstant2.- See Also:
- Constant Field Values
-
toField_WEIGHTCONSTANT2
public static final java.lang.String toField_WEIGHTCONSTANT2toField ROUTE name for SFFloat field named weightConstant2.- See Also:
- Constant Field Values
-
fromField_WEIGHTFUNCTION1
public static final java.lang.String fromField_WEIGHTFUNCTION1fromField ROUTE name for SFString field named weightFunction1.- See Also:
- Constant Field Values
-
toField_WEIGHTFUNCTION1
public static final java.lang.String toField_WEIGHTFUNCTION1toField ROUTE name for SFString field named weightFunction1.- See Also:
- Constant Field Values
-
fromField_WEIGHTFUNCTION2
public static final java.lang.String fromField_WEIGHTFUNCTION2fromField ROUTE name for SFString field named weightFunction2.- See Also:
- Constant Field Values
-
toField_WEIGHTFUNCTION2
public static final java.lang.String toField_WEIGHTFUNCTION2toField ROUTE name for SFString field named weightFunction2.- See Also:
- Constant Field Values
-
fromField_WEIGHTTRANSFERFUNCTION1
public static final java.lang.String fromField_WEIGHTTRANSFERFUNCTION1fromField ROUTE name for SFNode field named weightTransferFunction1.- See Also:
- Constant Field Values
-
toField_WEIGHTTRANSFERFUNCTION1
public static final java.lang.String toField_WEIGHTTRANSFERFUNCTION1toField ROUTE name for SFNode field named weightTransferFunction1.- See Also:
- Constant Field Values
-
fromField_WEIGHTTRANSFERFUNCTION2
public static final java.lang.String fromField_WEIGHTTRANSFERFUNCTION2fromField ROUTE name for SFNode field named weightTransferFunction2.- See Also:
- Constant Field Values
-
toField_WEIGHTTRANSFERFUNCTION2
public static final java.lang.String toField_WEIGHTTRANSFERFUNCTION2toField ROUTE name for SFNode field named weightTransferFunction2.- See Also:
- Constant Field Values
-
-
Constructor Details
-
BlendedVolumeStyleObject
public BlendedVolumeStyleObject()Constructor for BlendedVolumeStyleObject to initialize member variables with default values. -
BlendedVolumeStyleObject
public BlendedVolumeStyleObject(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: BlendedVolumeStyle- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the BlendedVolumeStyle 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 interfaceBlendedVolumeStyle
- 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 interfaceBlendedVolumeStyle
- Specified by:
setEnabled
in interfaceX3DComposableVolumeRenderStyleNode
- Specified by:
setEnabled
in interfaceX3DVolumeRenderStyleNode
- Parameters:
newValue
- is new value for the enabled field.- Returns:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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 X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceBlendedVolumeStyle
- 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 interfaceBlendedVolumeStyle
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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
-
getRenderStyle
Provide X3DComposableVolumeRenderStyleNode instance (using a properly typed node) from inputOutput SFNode field renderStyle.- Specified by:
getRenderStyle
in interfaceBlendedVolumeStyle
- Returns:
- value of renderStyle field
- See Also:
Tooltip: [X3DComposableVolumeRenderStyleNode] Single contained X3DComposableVolumeRenderStyleNode node that defines specific rendering technique for data in the voxels field, and the result is blended with parent VolumeData or SegmentedVoliumeData node. *
-
setRenderStyle
Accessor method to assign X3DComposableVolumeRenderStyleNode instance (using a properly typed node) to inputOutput SFNode field renderStyle.- Specified by:
setRenderStyle
in interfaceBlendedVolumeStyle
- Parameters:
newValue
- is new value for the renderStyle field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DComposableVolumeRenderStyleNode] Single contained X3DComposableVolumeRenderStyleNode node that defines specific rendering technique for data in the voxels field, and the result is blended with parent VolumeData or SegmentedVoliumeData node. *
-
clearRenderStyle
Utility method to clear SFNode value of renderStyle field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setRenderStyle
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field renderStyle.- Parameters:
newValue
- is new value for the renderStyle field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setRenderStyle(X3DComposableVolumeRenderStyleNode)
-
hasRenderStyle
public boolean hasRenderStyle()Indicate whether an object is available for inputOutput SFNode field renderStyle.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getRenderStyle()
,getRenderStyleProtoInstance()
-
getVoxels
Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.- Specified by:
getVoxels
in interfaceBlendedVolumeStyle
- Returns:
- value of voxels field
- See Also:
Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides second set of raw voxel information utilized by corresponding rendering styles. Any number of color components (1-4) may be defined. *
-
setVoxels
Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.- Specified by:
setVoxels
in interfaceBlendedVolumeStyle
- Parameters:
newValue
- is new value for the voxels field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides second set of raw voxel information utilized by corresponding rendering styles. Any number of color components (1-4) may be defined. *
-
clearVoxels
Utility method to clear SFNode value of voxels field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setVoxels
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field voxels.- Parameters:
newValue
- is new value for the voxels field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setVoxels(X3DTexture3DNode)
-
hasVoxels
public boolean hasVoxels()Indicate whether an object is available for inputOutput SFNode field voxels.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getVoxels()
,getVoxelsProtoInstance()
-
getWeightConstant1
public float getWeightConstant1()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant1.
Tooltip: [0,1] weightConstant1 is used when weightFunction1=CONSTANT. *- Specified by:
getWeightConstant1
in interfaceBlendedVolumeStyle
- Returns:
- value of weightConstant1 field
-
setWeightConstant1
Accessor method to assign float value to inputOutput SFFloat field named weightConstant1.
Tooltip: [0,1] weightConstant1 is used when weightFunction1=CONSTANT. *- Specified by:
setWeightConstant1
in interfaceBlendedVolumeStyle
- Parameters:
newValue
- is new value for the weightConstant1 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setWeightConstant1
Assign typed object value to SFFloat weightConstant1 field, similar tosetWeightConstant1(float)
.- Parameters:
newValue
- is new value for the weightConstant1 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setWeightConstant1
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetWeightConstant1(float)
.- Parameters:
newValue
- is new value for field- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getWeightConstant2
public float getWeightConstant2()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant2.
Tooltip: [0,1] weightConstant2 is used when weightFunction2=CONSTANT. *- Specified by:
getWeightConstant2
in interfaceBlendedVolumeStyle
- Returns:
- value of weightConstant2 field
-
setWeightConstant2
Accessor method to assign float value to inputOutput SFFloat field named weightConstant2.
Tooltip: [0,1] weightConstant2 is used when weightFunction2=CONSTANT. *- Specified by:
setWeightConstant2
in interfaceBlendedVolumeStyle
- Parameters:
newValue
- is new value for the weightConstant2 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setWeightConstant2
Assign typed object value to SFFloat weightConstant2 field, similar tosetWeightConstant2(float)
.- Parameters:
newValue
- is new value for the weightConstant2 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setWeightConstant2
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetWeightConstant2(float)
.- Parameters:
newValue
- is new value for field- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getWeightFunction1
public java.lang.String getWeightFunction1()Provide String enumeration value (baseType xs:NMTOKEN) ["CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE"] from inputOutput SFString field named weightFunction1.
Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 41.3, Weight function types https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-WeightFunctionTypes
- Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-transferFunctionToWeightMapping
Available enumeration values for string comparison:CONSTANT
,ALPHA1
,ALPHA2
,ONE_MINUS_ALPHA1
,ONE_MINUS_ALPHA2
,TABLE
.- Specified by:
getWeightFunction1
in interfaceBlendedVolumeStyle
- Returns:
- value of weightFunction1 field
-
setWeightFunction1
Accessor method to assign String enumeration value ("CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE") to inputOutput SFString field named weightFunction1.
Warning: authors can only choose from a strict list of enumeration values (CONSTANT
,ALPHA1
,ALPHA2
,ONE_MINUS_ALPHA1
,ONE_MINUS_ALPHA2
,TABLE
).
Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 41.3, Weight function types https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-WeightFunctionTypes
- Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-transferFunctionToWeightMapping
- Specified by:
setWeightFunction1
in interfaceBlendedVolumeStyle
- Parameters:
newValue
- is new value for the weightFunction1 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setWeightFunction1
Assign typed object value to SFString weightFunction1 field, similar tosetWeightFunction1(String)
.- Parameters:
newValue
- is new value for the weightFunction1 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getWeightFunction2
public java.lang.String getWeightFunction2()Provide String enumeration value (baseType xs:NMTOKEN) ["CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE"] from inputOutput SFString field named weightFunction2.
Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 41.3, Weight function types https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-WeightFunctionTypes
- Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-transferFunctionToWeightMapping
Available enumeration values for string comparison:CONSTANT
,ALPHA1
,ALPHA2
,ONE_MINUS_ALPHA1
,ONE_MINUS_ALPHA2
,TABLE
.- Specified by:
getWeightFunction2
in interfaceBlendedVolumeStyle
- Returns:
- value of weightFunction2 field
-
setWeightFunction2
Accessor method to assign String enumeration value ("CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE") to inputOutput SFString field named weightFunction2.
Warning: authors can only choose from a strict list of enumeration values (CONSTANT
,ALPHA1
,ALPHA2
,ONE_MINUS_ALPHA1
,ONE_MINUS_ALPHA2
,TABLE
).
Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 41.3, Weight function types https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-WeightFunctionTypes
- Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-transferFunctionToWeightMapping
- Specified by:
setWeightFunction2
in interfaceBlendedVolumeStyle
- Parameters:
newValue
- is new value for the weightFunction2 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setWeightFunction2
Assign typed object value to SFString weightFunction2 field, similar tosetWeightFunction2(String)
.- Parameters:
newValue
- is new value for the weightFunction2 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getWeightTransferFunction1
Provide X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction1.- Specified by:
getWeightTransferFunction1
in interfaceBlendedVolumeStyle
- Returns:
- value of weightTransferFunction1 field
- See Also:
getWeightTransferFunction1ProtoInstance()
-
setWeightTransferFunction1
Accessor method to assign X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction1.- Specified by:
setWeightTransferFunction1
in interfaceBlendedVolumeStyle
- Parameters:
newValue
- is new value for the weightTransferFunction1 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setWeightTransferFunction1(ProtoInstanceObject)
-
clearWeightTransferFunction1
Utility method to clear SFNode value of weightTransferFunction1 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setWeightTransferFunction1
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field weightTransferFunction1.- Parameters:
newValue
- is new value for the weightTransferFunction1 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setWeightTransferFunction1(X3DTexture2DNode)
-
hasWeightTransferFunction1
public boolean hasWeightTransferFunction1()Indicate whether an object is available for inputOutput SFNode field weightTransferFunction1.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getWeightTransferFunction1()
,getWeightTransferFunction1ProtoInstance()
-
getWeightTransferFunction2
Provide X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction2.- Specified by:
getWeightTransferFunction2
in interfaceBlendedVolumeStyle
- Returns:
- value of weightTransferFunction2 field
- See Also:
getWeightTransferFunction2ProtoInstance()
-
setWeightTransferFunction2
Accessor method to assign X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction2.- Specified by:
setWeightTransferFunction2
in interfaceBlendedVolumeStyle
- Parameters:
newValue
- is new value for the weightTransferFunction2 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setWeightTransferFunction2(ProtoInstanceObject)
-
clearWeightTransferFunction2
Utility method to clear SFNode value of weightTransferFunction2 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setWeightTransferFunction2
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field weightTransferFunction2.- Parameters:
newValue
- is new value for the weightTransferFunction2 field.- Returns:
BlendedVolumeStyleObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setWeightTransferFunction2(X3DTexture2DNode)
-
hasWeightTransferFunction2
public boolean hasWeightTransferFunction2()Indicate whether an object is available for inputOutput SFNode field weightTransferFunction2.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getWeightTransferFunction2()
,getWeightTransferFunction2ProtoInstance()
-
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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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:
BlendedVolumeStyleObject
- 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)
-