RAClipPlane

class ansys.rocky.app.ra_clip_plane.RAClipPlane(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem, ansys.rocky.app._ra_orientation_mixin._RAOrientationMixin, ansys.rocky.app.motion._with_movement_mixin._WithMovementMixin

Rocky PrePost Scripting wrapper for a single Clip Plane.

This wrapper class corresponds to an individual entry under the “3D Clip Planes” item on the project’s data tree. Clip Planes can be retrieved from the RAClipPlaneCollection via:

clip_plane = clip_plane_collection.GetClipPlane('Clip Plane <1>')

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetOrigin	Returns the X, Y and Z plane origin
SetOrigin	Set the X, Y and Z parameters of the plane origin
SetRelativeRotationVector	Set the X, Y and Z parameters of the plane normal
GetRelativeRotationVector	Returns the X, Y and Z parameters of the plane normal
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetPlaneOrigin	Get the value of “Plane Origin”.
SetPlaneOrigin	Set the values of “Plane Origin”.
GetShowTool	Get the value of “Show Tool”.
SetShowTool	Set the value of “Show Tool”.
EnableTool	Set the value of “Tool” to True.
DisableTool	Set the value of “Tool” to False.
IsToolEnabled	Check if the “Tool” is enabled.

Import detail

from ansys.rocky.app.ra_clip_plane import RAClipPlane

Method detail

classmethod RAClipPlane.GetWrappedClass() → type[rocky30.models.vizu_clip_plane.vizu_clip_plane_subject.VizuClipPlaneSubject]

classmethod RAClipPlane.GetClassName() → str

RAClipPlane.GetOrigin(unit: str | None = None) → rocky30.base_types.Tuple3F

Returns the X, Y and Z plane origin

RAClipPlane.SetOrigin(x: float, y: float, z: float, unit: str | None = None) → None

Set the X, Y and Z parameters of the plane origin

RAClipPlane.SetRelativeRotationVector(x: float, y: float, z: float) → None

Set the X, Y and Z parameters of the plane normal

RAClipPlane.GetRelativeRotationVector() → rocky30.base_types.Tuple3F

Returns the X, Y and Z parameters of the plane normal

RAClipPlane.GetName() → str

Get the value of “Name”.

RAClipPlane.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RAClipPlane.GetPlaneOrigin(unit: str | None = None) → list[float]

Get the value of “Plane Origin”.

Parameters:

unit – The unit for the returned values. If no unit is provided, the returned values will be in “m”.

RAClipPlane.SetPlaneOrigin(values: collections.abc.Sequence[str | float], unit: str | None = None) → None

Set the values of “Plane Origin”.

Parameters:

• values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.

• unit – The unit for values. If no unit is provided, values is assumed to be in “m”.

Raises:

RockyApiError – If values doesn’t have exactly 3 elements.

RAClipPlane.GetShowTool() → bool

Get the value of “Show Tool”.

RAClipPlane.SetShowTool(value: bool) → None

Set the value of “Show Tool”.

Parameters:

value – The value to set.

RAClipPlane.EnableTool() → None

Set the value of “Tool” to True.

RAClipPlane.DisableTool() → None

Set the value of “Tool” to False.

RAClipPlane.IsToolEnabled() → bool

Check if the “Tool” is enabled.