Rendering

mechanica.ClipPlane: alias of MxClipPlane

class mechanica.MxClipPlane(i: int)

property index: Index of the clip plane. Less than zero if clip plane has been destroyed.

property point: MxVector3f

property normal: MxVector3f

getEquation() → MxVector4f

Get the coefficients of the plane equation of the clip plane

Return type: MxVector4f
Returns: MxVector4f

setEquation(*args) → HRESULT

Overload 1:

Set the coefficients of the plane equation of the clip plane

Parameters: pe (MxVector4f) –
Return type: int
Returns: HRESULT

Overload 2:

Set the coefficients of the plane equation of the clip plane using a point on the plane and its normal

Parameters

point (MxVector3f) – plane point
normal (MxVector3f) – plane normal vector

Return type

int

Returns

HRESULT

destroy() → HRESULT

Destroy the clip plane

Return type: int
Returns: HRESULT

mechanica.ClipPlanes: alias of MxClipPlanes

class mechanica.MxClipPlanes

static len() → int

Get the number of clip planes

Return type: int
Returns: int

static getClipPlaneEquation(index: unsigned int const &) → MxVector4f const &

Get the coefficients of the equation of a clip plane

Parameters: index (int) – index of the clip plane
Return type: MxVector4f
Returns: const MxVector4f&

static setClipPlaneEquation(index: unsigned int const &, pe: MxVector4f) → HRESULT

Set the coefficients of the equation of a clip plane.

The clip plane must already exist

Parameters

index (int) – index of the clip plane
pe (MxVector4f) – coefficients of the plane equation of the clip plane

Return type

int

Returns

HRESULT

static item(index: unsigned int const &) → MxClipPlane

Get a clip plane by index

Parameters: index (int) – index of the clip plane
Return type: MxClipPlane
Returns: MxClipPlane

static create(*args) → MxClipPlane

Overload 1:

Create a clip plane

Parameters: pe (MxVector4f) – coefficients of the equation of the plane
Return type: MxClipPlane
Returns: MxClipPlane

Overload 2:

Create a clip plane

Parameters

point (MxVector3f) – point on the clip plane
normal (MxVector3f) – normal of the clip plane

Return type

MxClipPlane

Returns

MxClipPlane

class mechanica.SubRendererFlags(value)

Flags for referencing subrenderers in select methods

angle = 1: Angle subrenderer

arrow = 2: Arrow subrenderer

bond = 4: Bond subrenderer

dihedral = 8: Dihedral subrenderer