VectorGeometryToolPlaneReference

class ansys.stk.core.analysis_workbench.VectorGeometryToolPlaneReference

Bases: IAnalysisWorkbenchComponentReference

Represents a Plane reference.

Overview

Methods

set_path	Set a new plane using a specified path.
set_plane	Set a new plane.
get_plane	Return the actual plane object behind the reference. Use IAnalysisWorkbenchComponent.IsValid to test the validity of the returned object.
has_cyclic_dependency	Test whether the input component and the target component form a cyclic dependency.

Import detail

from ansys.stk.core.analysis_workbench import VectorGeometryToolPlaneReference

Method detail

VectorGeometryToolPlaneReference.set_path(self, path: str) → None

Set a new plane using a specified path.

Parameters:

path : str

Returns:

None

VectorGeometryToolPlaneReference.set_plane(self, plane: IVectorGeometryToolPlane) → None

Set a new plane.

Parameters:

plane : IVectorGeometryToolPlane

Returns:

None

VectorGeometryToolPlaneReference.get_plane(self) → IVectorGeometryToolPlane

Return the actual plane object behind the reference. Use IAnalysisWorkbenchComponent.IsValid to test the validity of the returned object.

Returns:

IVectorGeometryToolPlane

VectorGeometryToolPlaneReference.has_cyclic_dependency(self, plane: IVectorGeometryToolPlane) → bool

Test whether the input component and the target component form a cyclic dependency.

Parameters:

plane : IVectorGeometryToolPlane

Returns:

bool