`RAClipPlaneCollection`#

class ansys.rocky.app.ra_clip_plane_collection.RAClipPlaneCollection(id: str, model_id: str | None = None)#

Rocky PrePost Scripting wrapper for the collection of Clip Planes in a project.

This wrapper corresponds to the “3D Clip Planes” item in the project’s data tree. To retrieve the RAClipPlaneCollection from a RAProject, use:

clip_planes_collection = project.Get3DClipPlanesCollection()

Overview#

Constructors

`GetWrappedClass`
`GetClassName`

Methods

`GetClipPlaneNames`	Get a list with the name of the clip planes.
`GetClipPlaneByName`	Get the clip plane with the given name.
`CreateClipPlane`	Create a new clip plane with the (optionally) given name, origin and normal.
`RemoveClipPlane`	Removes the given clip plane from the project.

from ansys.rocky.app.ra_clip_plane_collection import RAClipPlaneCollection

classmethod RAClipPlaneCollection.GetWrappedClass() → type[rocky30.models.vizu_clip_plane.vizu_clip_plane_collection.VizuClipPlaneCollection]#

RAClipPlaneCollection.GetClipPlaneNames() → list[str]#: Get a list with the name of the clip planes.

RAClipPlaneCollection.GetClipPlaneByName(name: str) → ansys.rocky.app.ra_clip_plane.RAClipPlane#: Get the clip plane with the given name.

RAClipPlaneCollection.CreateClipPlane(name: str | None = None, origin: rocky30.base_types.Tuple3F | None = None, normal: rocky30.base_types.Tuple3F | None = None) → ansys.rocky.app.ra_clip_plane.RAClipPlane#: Create a new clip plane with the (optionally) given name, origin and normal. Returns the newly created clip plane.

RAClipPlaneCollection.RemoveClipPlane(clip_plane: ansys.rocky.app.ra_clip_plane.RAClipPlane | str) → None#

Removes the given clip plane from the project.