Interface CartoonVolumeStyle
- All Superinterfaces:
X3DComposableVolumeRenderStyleNode,X3DNode,X3DVolumeRenderStyleNode
- All Known Implementing Classes:
CartoonVolumeStyleObject
public interface CartoonVolumeStyle extends X3DComposableVolumeRenderStyleNode
CartoonVolumeStyle generates cartoon-style non-photorealistic rendering of associated volumetric data.
X3D node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] CartoonVolumeStyle generates cartoon-style non-photorealistic rendering of associated volumetric data.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
X3D node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] CartoonVolumeStyle generates cartoon-style non-photorealistic rendering of associated volumetric data.
- Hint: contains single Texture3D node with containerField='surfaceNormals'
- Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='3'/>
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and Type Method Description intgetColorSteps()Provide int value using RGB values [0..1] from inputOutput SFInt32 field named colorSteps.booleangetEnabled()Provide boolean value from inputOutput SFBool field named enabled.X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float[]getOrthogonalColor()Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named orthogonalColor.float[]getParallelColor()Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named parallelColor.X3DTexture3DNodegetSurfaceNormals()Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.CartoonVolumeStylesetColorSteps(int newValue)Accessor method to assign int value to inputOutput SFInt32 field named colorSteps.CartoonVolumeStylesetEnabled(boolean newValue)Accessor method to assign boolean value to inputOutput SFBool field named enabled.CartoonVolumeStylesetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.CartoonVolumeStylesetOrthogonalColor(float[] newValue)Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named orthogonalColor.CartoonVolumeStylesetParallelColor(float[] newValue)Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named parallelColor.CartoonVolumeStylesetSurfaceNormals(X3DTexture3DNode newValue)Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field surfaceNormals.
-
Method Details
-
getColorSteps
int getColorSteps()Provide int value using RGB values [0..1] from inputOutput SFInt32 field named colorSteps.
Tooltip: [1,64] Number of distinct colors taken from interpolated colors and used to render the object.- Hint: colorSteps=1 means no color interpolation takes place, only use orthogonalColor.
- Hint: parallelColor and orthogonalColor interpolation is in HSV color space for RGB components, linearly for alpha component.
- Returns:
- value of colorSteps field
-
setColorSteps
Accessor method to assign int value to inputOutput SFInt32 field named colorSteps.
Tooltip: [1,64] Number of distinct colors taken from interpolated colors and used to render the object.- Hint: colorSteps=1 means no color interpolation takes place, only use orthogonalColor.
- Hint: parallelColor and orthogonalColor interpolation is in HSV color space for RGB components, linearly for alpha component.
- Parameters:
newValue- is new value for the colorSteps field.- Returns:
CartoonVolumeStyle- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getEnabled
boolean getEnabled()Provide boolean value from inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
getEnabledin interfaceX3DComposableVolumeRenderStyleNode- Specified by:
getEnabledin 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:
setEnabledin interfaceX3DComposableVolumeRenderStyleNode- Specified by:
setEnabledin interfaceX3DVolumeRenderStyleNode- Parameters:
newValue- is new value for the enabled field.- Returns:
CartoonVolumeStyle- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
X3DMetadataObject getMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
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
- Specified by:
getMetadatain interfaceX3DComposableVolumeRenderStyleNode- Specified by:
getMetadatain interfaceX3DNode- Specified by:
getMetadatain interfaceX3DVolumeRenderStyleNode- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
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
- Specified by:
setMetadatain interfaceX3DComposableVolumeRenderStyleNode- Specified by:
setMetadatain interfaceX3DNode- Specified by:
setMetadatain interfaceX3DVolumeRenderStyleNode- Parameters:
newValue- is new value for the metadata field.- Returns:
CartoonVolumeStyle- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
getOrthogonalColor
float[] getOrthogonalColor()Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named orthogonalColor.
Tooltip: [0,1] orthogonalColor is used for surface normals that are orthogonal (perpendicular) to viewer's current location.- Hint: plane of surface itself is orthogonal to user's view direction.
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Returns:
- value of orthogonalColor field
-
setOrthogonalColor
Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named orthogonalColor.
Tooltip: [0,1] orthogonalColor is used for surface normals that are orthogonal (perpendicular) to viewer's current location.- Hint: plane of surface itself is orthogonal to user's view direction.
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Parameters:
newValue- is new value for the orthogonalColor field.- Returns:
CartoonVolumeStyle- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getParallelColor
float[] getParallelColor()Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named parallelColor.
Tooltip: [0,1] parallelColor is used for surface normals that are orthogonal to viewer's current location.- Hint: plane of surface itself is parallel to user's view direction.
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Returns:
- value of parallelColor field
-
setParallelColor
Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named parallelColor.
Tooltip: [0,1] parallelColor is used for surface normals that are orthogonal to viewer's current location.- Hint: plane of surface itself is parallel to user's view direction.
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Parameters:
newValue- is new value for the parallelColor field.- Returns:
CartoonVolumeStyle- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSurfaceNormals
X3DTexture3DNode getSurfaceNormals()Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.- Returns:
- value of surfaceNormals field
-
setSurfaceNormals
Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field surfaceNormals.- Parameters:
newValue- is new value for the surfaceNormals field.- Returns:
CartoonVolumeStyle- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-