ClipPlaneYDir Option

The ClipPlaneYDir option changes the clipping plane’s normal Y direction value when the ClipPlaneOrientation is set to 3. The OptionValue is set to any number. The ratio of the numbers for the ClipPlaneXDir, ClipPlaneYDir, and ClipPlaneZDir determine the angle of the clipping plane.

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(“ClipPlaneYDir”, “OptionValue”)

object.Do() or object.DoOnce()

Example

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 ("ClipPlaneYDir", "1")

CommandApi.Do()

Used by: ClipPlane module