ClipGeomOrth

DESCRIPTION

This module allows up to 6 clipping planes, set orthogonally to the principal axes, to be added to the incoming geometry. These planes cause the Render module to clip (ie. not draw) the geometry that falls on the outside of these planes. The planes may be individually turned on or off and they affect only the geometry that passes through the module. All other geometry in the Render module will be drawn as normal.

The clip planes may be visually represented in the Render module to aid positioning and are color coded as:

X planes -> Red, Y planes -> Green and Z planes -> Blue.

INPUTS

Port: Geom
Type: Geometry
Optional: This port is optional.

The incoming geometry that is to be clipped. Only one geometry object may be handled at a time by this port.

WIDGETS

Port: Xmin
Type: Slider

The position on the X axis of the Xmin clip plane. This plane clips geometry in the negative X direction.

Port: Xmax
Type: Slider

The position on the X axis of the Xmax clip plane. This plane clips geometry in the positive X direction.

Port: Ymin
Type: Slider

The position on the Y axis of the Ymin clip plane. This plane clips geometry in the negative Y direction.

Port: Ymax
Type: Slider

The position on the Y axis of the Ymax clip plane. This plane clips geometry in the positive Y direction.

Port: Zmin
Type: Slider

The position on the Z axis of the Zmin clip plane. This plane clips geometry in the negative Z direction.

Port: Zmax
Type: Slider

The position on the Z axis of the Zmax clip plane. This plane clips geometry in the positive Z direction.

Port: Xmin Active
Type: Option Menu
Menu Item: False
Menu Item: True

Set whether the Xmin plane is active (True) or not (False).

Port: Xmax Active
Type: Option Menu
Menu Item: False
Menu Item: True

Set whether the Xmax plane is active (True) or not (False).

Port: Ymin Active
Type: Option Menu
Menu Item: False
Menu Item: True

Set whether the Ymin plane is active (True) or not (False).

Port: Ymax Active
Type: Option Menu
Menu Item: False
Menu Item: True

Set whether the Ymax plane is active (True) or not (False).

Port: Zmin Active
Type: Option Menu
Menu Item: False
Menu Item: True

Set whether the Zmin plane is active (True) or not (False).

Port: Zmax Active
Type: Option Menu
Menu Item: False
Menu Item: True

Set whether the Zmax plane is active (True) or not (False).

Port: Reset
Type: Button

Resets the position sliders to either the maximum (max sliders) or minimum (min sliders) positions. Also sets the representation to none.

Port: Representation
Type: Option Menu
Menu Item: None
Menu Item: Outline
Menu Item: Plane
Menu Item: Outline if Active
Menu Item: Plane if Active

The position of the clipping planes within the scene may be represented as an outline (Outline and Outline if Active options) or a semi-transparent plane (Plane and Plane if Active options). The Xmin and Xmax planes are colored red, the Ymin and Ymax planes are colored green and the Zmin and Zmax planes are colored blue (XYZ -> RGB) to aid identification within the Render module. When the 'if Active' options are used, then only those planes that are currently turned on have a visual representation.

OUTPUTS

Port: ClippedGeom
Type: Geometry

The incoming geometry plus any active clipping planes and any clip plane representations.

KNOWN PROBLEMS

When using Outline or Outline if Active representations, and the edges of the representations of the planes coincide (e.g. when all set to the maximum extent of the bounding box) then the outlines will have coincident edges and it is uncertain which edge will take precedence when displayed.

SEE ALSO

ClipGeom ClipGeomWedge


[Documentation Home]