Tissue Forge C++ 0.2.1
Interactive, particle-based physics, chemistry and biology modeling and simulation environment
Loading...
Searching...
No Matches
TissueForge::rendering::ClipPlane Struct Reference

Public Member Functions

 ClipPlane (int i)
 
fVector3 getPoint ()
 Get the point of the clip plane.
 
fVector3 getNormal ()
 Get the normal vector of the clip plane.
 
fVector4 getEquation ()
 Get the coefficients of the plane equation of the clip plane.
 
HRESULT setEquation (const fVector4 &pe)
 Set the coefficients of the plane equation of the clip plane.
 
HRESULT setEquation (const fVector3 &point, const fVector3 &normal)
 Set the coefficients of the plane equation of the clip plane using a point on the plane and its normal.
 
HRESULT destroy ()
 Destroy the clip plane.
 

Public Attributes

int index
 

Member Function Documentation

◆ destroy()

HRESULT TissueForge::rendering::ClipPlane::destroy ( )

Destroy the clip plane.

Returns
HRESULT

◆ getEquation()

fVector4 TissueForge::rendering::ClipPlane::getEquation ( )

Get the coefficients of the plane equation of the clip plane.

Returns
fVector4

◆ getNormal()

fVector3 TissueForge::rendering::ClipPlane::getNormal ( )

Get the normal vector of the clip plane.

Returns
fVector3

◆ getPoint()

fVector3 TissueForge::rendering::ClipPlane::getPoint ( )

Get the point of the clip plane.

Returns
fVector3

◆ setEquation() [1/2]

HRESULT TissueForge::rendering::ClipPlane::setEquation ( const fVector3 & point,
const fVector3 & normal )

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

Parameters
pointplane point
normalplane normal vector
Returns
HRESULT

◆ setEquation() [2/2]

HRESULT TissueForge::rendering::ClipPlane::setEquation ( const fVector4 & pe)

Set the coefficients of the plane equation of the clip plane.

Parameters
pe
Returns
HRESULT

Member Data Documentation

◆ index

int TissueForge::rendering::ClipPlane::index

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


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