ClipPlaneOrientation Option

The ClipPlaneOrientation option changes the axis orientation that is being clipped. The OptionValue is 0, 1, 2, or 3. 0 specifies to clip along X, 1 along Y, 2 along Z, and 3 to a Custom direction.

Use the ClipPlaneXDir, ClipPlaneYDir, and ClipPlaneZDir when the ClipPlaneOrientation is 3.

Syntax

object.Construct(“CreateModule”)

object.Option(“SourceModule”, “data file name”)

object.Option(“Type”, “ClipPlane”)

object.Do() or object.DoOnce()

object.Construct(“ModifyModule”)

object.Option(“Module”, “ClipPlane”)

object.Option(“ClipPlaneOrientation”, “OptionValue”)

object.Do() or object.DoOnce()

Example 1

This example shows how to alter the axis that the clip plane is showing to clip along Z.

CommandApi.Construct ("ModifyModule")

CommandApi.Option ("Module", "ClipPlane")

CommandApi.Option ("ClipPlaneOrientation", "2")

CommandApi.Do()

Example 2

This example shows how to alter the axis that the clip plane is showing to clip along a custom angle.

'Alter the axis that the clip plane is showing - clip Custom angle

CommandApi.Construct ("ModifyModule")

CommandApi.Option ("Module", "ClipPlane")

CommandApi.Option ("ClipPlaneOrientation", "3")

CommandApi.Do()

'Set the clip orientation

CommandApi.Option ("ClipPlaneXDir", "1")

CommandApi.Do()

CommandApi.Option ("ClipPlaneYDir", "1")

CommandApi.Do()

CommandApi.Option ("ClipPlaneZDir", "2")

CommandApi.Do()

Used by: ClipPlane module