Rendering

class tissue_forge.rendering.ClipPlane(i: int)
property index

Index of the clip plane. Less than zero if clip plane has been destroyed.

property point: fVector3
property normal: fVector3
getEquation() TissueForge::fVector4

Get the coefficients of the plane equation of the clip plane

Return type:

fVector4

Returns:

fVector4

setEquation(*args) HRESULT

Overload 1:

Set the coefficients of the plane equation of the clip plane

Parameters:

pe (fVector4) –

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 (fVector3) – plane point

  • normal (fVector3) – plane normal vector

Return type:

int

Returns:

HRESULT

destroy() HRESULT

Destroy the clip plane

Return type:

int

Returns:

HRESULT

class tissue_forge.rendering.ClipPlanes
static len() int

Get the number of clip planes

Return type:

int

Returns:

int

static getClipPlaneEquation(index: unsigned int const &) TissueForge::fVector4 const &

Get the coefficients of the equation of a clip plane

Parameters:

index (int) – index of the clip plane

Return type:

fVector4

Returns:

const fVector4&

static setClipPlaneEquation(index: unsigned int const &, pe: fVector4) 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 (fVector4) – coefficients of the plane equation of the clip plane

Return type:

int

Returns:

HRESULT

static item(index: unsigned int const &) TissueForge::rendering::ClipPlane

Get a clip plane by index

Parameters:

index (int) – index of the clip plane

Return type:

ClipPlane

Returns:

ClipPlane

static create(*args) TissueForge::rendering::ClipPlane

Overload 1:

Create a clip plane

Parameters:

pe (fVector4) – coefficients of the equation of the plane

Return type:

ClipPlane

Returns:

ClipPlane


Overload 2:

Create a clip plane

Parameters:
  • point (fVector3) – point on the clip plane

  • normal (fVector3) – normal of the clip plane

Return type:

ClipPlane

Returns:

ClipPlane