Package org.web3d.x3d.sai.Rendering

Interface ClipPlane

All Superinterfaces:

X3DChildNode, X3DNode

All Known Implementing Classes:

ClipPlane

public interface ClipPlane
extends X3DChildNode

ClipPlane specifies a single plane equation used to clip (i.

X3D node tooltip: (X3D version 3.2 or later) [X3DChildNode] ClipPlane specifies a single plane equation used to clip (i.e. cull or hide) displayed geometry. The plane field specifies a four-component plane equation that describes both inside and outside half space.

• Hint: ClipPlane nodes only affect peer and descendant nodes, thus a parent grouping node can limit its effect.
• Warning: requires X3D profile='Full' or else include <component name='Rendering' level='5'/> Examples: X3D Example Archives, Basic, CAD, Clip Plane Example https://www.web3d.org/x3d/content/examples/Basic/CAD/ClipPlaneExampleIndex.html

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification, X3D Abstract Specification: ClipPlane, X3D Tooltips: ClipPlane, X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	Description
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float[]	getPlane()	Provide array of 4-tuple float results within allowed range of [-1,1] from inputOutput SFVec4f field named plane.
ClipPlane	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
ClipPlane	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ClipPlane	setPlane(float[] newValue)	Accessor method to assign 4-tuple float array to inputOutput SFVec4f field named plane.

Method Details

getEnabled

boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Returns:

value of enabled field

setEnabled

ClipPlane setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getMetadata

X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.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/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

ClipPlane setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.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/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

getPlane

float[] getPlane()

Provide array of 4-tuple float results within allowed range of [-1,1] from inputOutput SFVec4f field named plane.

Tooltip: [0,1] If (a,b,c,d) is the plane, with the first three components being a normalized vector describing the plane's normal direction (and thus the fourth component d being distance from the origin), a point (x,y,z) is visible to the user, with regards to the clipping plane, if a*x+b*y+c*z+d is greater than 0.

• Warning: (a, b, c) value of (0, 0, 0) is forbidden since the zero vector has ambiguous direction and is thus degenerate, not defining a plane.
• Hint: negate all plane values to reverse which side of plane has visibility clipped.
• Hint: plane-geometry equations https://en.wikipedia.org/wiki/Plane_(geometry)#Point-normal_form_and_general_form_of_the_equation_of_a_plane
• Hint: plane-geometry distance to point https://en.wikipedia.org/wiki/Plane_(geometry)#Distance_from_a_point_to_a_plane

Returns:

value of plane field

setPlane

ClipPlane setPlane(float[] newValue)

Accessor method to assign 4-tuple float array to inputOutput SFVec4f field named plane.

Tooltip: [0,1] If (a,b,c,d) is the plane, with the first three components being a normalized vector describing the plane's normal direction (and thus the fourth component d being distance from the origin), a point (x,y,z) is visible to the user, with regards to the clipping plane, if a*x+b*y+c*z+d is greater than 0.

• Warning: (a, b, c) value of (0, 0, 0) is forbidden since the zero vector has ambiguous direction and is thus degenerate, not defining a plane.
• Hint: negate all plane values to reverse which side of plane has visibility clipped.
• Hint: plane-geometry equations https://en.wikipedia.org/wiki/Plane_(geometry)#Point-normal_form_and_general_form_of_the_equation_of_a_plane
• Hint: plane-geometry distance to point https://en.wikipedia.org/wiki/Plane_(geometry)#Distance_from_a_point_to_a_plane

Parameters:

newValue - is new value for the plane field.

Returns:

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