Module vrClippingModule

[frames] | no frames]

Module vrClippingModule

Functions

cloneClippingContour()
Clones the contour.

enableClippingPlane(state)
Enables/disables clipping.

Vec3f

getClippingContourColor()
Gets the color of the clipping contour.

int

getClippingContourWidth()
Gets the width of the contour.

Vec3f

getClippingGridColor()
Gets the color of the clipping grid.

bool

getClippingHideScene()
Gets the hide scene flag of the clipping plane.

Vec3f

getClippingPlaneColor()
Gets the color of the clipping plane.

bool

getClippingPlaneInvertDirection()
Gets the inversion flag of the clipping plane.

Vec3f

getClippingPlaneNormal()
Gets the normal of the clipping plane.

Pnt3f

getClippingPlanePosition()
Gets the position of the clipping plane.

bool

getClippingPlaneState()
Gets the clipping plane status.

bool

getClippingShowContour()
Gets the show contour flag.

bool

getClippingShowGrid()
Gets the show grid flag.

bool

getClippingShowManipulator()
Gets the show manipulator flag.

bool

getClippingShowPlane()
Gets the show plane flag.

setClippingContourVisualization(state, color, width)
Sets the clipping grid visualization.

setClippingGridVisualization(state, color)
Sets the clipping grid visualization.

setClippingHideScene(state)
Shows/hides the scene during clipping.

setClippingPlane(position, normal, flipped)
Sets the clipping plane.

setClippingPlanePosition(position)
Sets the position of the clipping plane.

setClippingPlaneQuaternionRotation(axis, angle)
Sets the rotation of the clipping plane with a quaternion.

setClippingPlaneRotation(rotationX, rotationY, rotationZ)
Sets the rotation of the clipping plane with euler rotation angles.

setClippingPlaneVisualization(state, color)
Sets the clipping plane visualization.

setClippingShowManipulator(state)
Shows/hides the clipping manipulator.

Function Details

enableClippingPlane(state)

Enables/disables clipping.

Parameters:

state (bool) - Clipping: Enable/Disable.

getClippingContourColor()

Gets the color of the clipping contour.

Returns: Vec3f: A vector with r, g and b values.

getClippingContourWidth()

Gets the width of the contour.

Returns: int: a int flag.

getClippingGridColor()

Gets the color of the clipping grid.

Returns: Vec3f: A vector with r, g and b values.

getClippingHideScene()

Gets the hide scene flag of the clipping plane.

Returns: bool: a bool flag.

getClippingPlaneColor()

Gets the color of the clipping plane.

Returns: Vec3f: A vector with r, g and b values.

getClippingPlaneInvertDirection()

Gets the inversion flag of the clipping plane.

Returns: bool: a bool flag.

getClippingPlaneNormal()

Gets the normal of the clipping plane.

Returns: Vec3f: A vector with x, y and z coordinates.

getClippingPlanePosition()

Gets the position of the clipping plane.

Returns: Pnt3f: A vector with x, y and z coordinates.

getClippingPlaneState()

Gets the clipping plane status.

Returns: bool: a bool flag.

getClippingShowContour()

Gets the show contour flag.

Returns: bool: a bool flag.

getClippingShowGrid()

Gets the show grid flag.

Returns: bool: a bool flag.

getClippingShowManipulator()

Gets the show manipulator flag.

Returns: bool: a bool flag.

getClippingShowPlane()

Gets the show plane flag.

Returns: bool: a bool flag.

setClippingContourVisualization(state, color, width)

Sets the clipping grid visualization.

Parameters:

state (bool) - Clipping contour visualization: Enable/Disable.
color (Vec3f) - Sets the color of the clipping contour visualization.
width (int) - Sets the width of the clipping contour visualization.

setClippingGridVisualization(state, color)

Sets the clipping grid visualization.

Parameters:

state (bool) - Clipping grid visualization: Enable/Disable.
color (Vec3f) - Sets the color of the clipping grid visualization.

setClippingHideScene(state)

Shows/hides the scene during clipping.

Parameters:

state (bool) - Show/hide the scene.

setClippingPlane(position, normal, flipped)

Sets the clipping plane.

Parameters:

position (Pnt3f) - The position of the clipping plane.
normal (Vec3f) - The normal of the clipping plane.
flipped (bool) - Sets the direction of the normal.

setClippingPlanePosition(position)

Sets the position of the clipping plane.

Parameters:

position (Pnt3f) - A vector with x, y and z coordinates.

setClippingPlaneQuaternionRotation(axis, angle)

Sets the rotation of the clipping plane with a quaternion.

Parameters:

axis (Vec3f) - Rotation axis.
angle (float) - Rotation angle in degrees.

setClippingPlaneRotation(rotationX, rotationY, rotationZ)

Sets the rotation of the clipping plane with euler rotation angles.

Parameters:

rotationX (float) - Euler rotation angle x in degrees.
rotationY (float) - Euler rotation angle y in degrees.
rotationZ (float) - Euler rotation angle z in degrees.

setClippingPlaneVisualization(state, color)

Sets the clipping plane visualization.

Parameters:

state (bool) - Clipping plane visualization: Enable/Disable.
color (Vec3f) - Sets the color of the clipping plane visualization.

setClippingShowManipulator(state)

Shows/hides the clipping manipulator.

Parameters:

state (bool) - Clipping manipulator: Enable/Disable.