TissueForge::rendering::ClipPlanes Struct Reference

Static Public Member Functions
static int	len ()
	Get the number of clip planes.
static const fVector4 &	getClipPlaneEquation (const unsigned int &index)
	Get the coefficients of the equation of a clip plane.
static HRESULT	setClipPlaneEquation (const unsigned int &index, const fVector4 &pe)
	Set the coefficients of the equation of a clip plane.
static ClipPlane	item (const unsigned int &index)
	Get a clip plane by index.
static ClipPlane	create (const fVector4 &pe)
	Create a clip plane.
static ClipPlane	create (const fVector3 &point, const fVector3 &normal)
	Create a clip plane.

Member Function Documentation

create() [1/2]

static ClipPlane TissueForge::rendering::ClipPlanes::create ( const fVector3 & point, const fVector3 & normal )

static

Create a clip plane.

Parameters

point	point on the clip plane
normal	normal of the clip plane

Returns

ClipPlane

create() [2/2]

static ClipPlane TissueForge::rendering::ClipPlanes::create ( const fVector4 & pe )

static

Create a clip plane.

Parameters

pe	coefficients of the equation of the plane

Returns

ClipPlane

getClipPlaneEquation()

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

static

Get the coefficients of the equation of a clip plane.

Parameters

index

index of the clip plane

Returns

const fVector4&

item()

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

static

Get a clip plane by index.

Parameters

index

index of the clip plane

Returns

ClipPlane

len()

static int TissueForge::rendering::ClipPlanes::len ( )

static

Get the number of clip planes.

Returns

int

setClipPlaneEquation()

static HRESULT TissueForge::rendering::ClipPlanes::setClipPlaneEquation ( const unsigned int & index, const fVector4 & pe )

static

Set the coefficients of the equation of a clip plane.

The clip plane must already exist

Parameters

index	index of the clip plane
pe	coefficients of the plane equation of the clip plane

Returns

HRESULT

---

The documentation for this struct was generated from the following file:

• source/rendering/tfClipPlane.h