tfCClipPlane.h File Reference

#include "tf_port_c.h"

Include dependency graph for tfCClipPlane.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	tfRenderingClipPlaneHandle
	Handle to a rendering::ClipPlane instance. More...

Functions
HRESULT	tfRenderingClipPlane_getIndex (struct tfRenderingClipPlaneHandle *handle, int *index)
	Get the index of the clip plane.
HRESULT	tfRenderingClipPlane_getPoint (struct tfRenderingClipPlaneHandle *handle, float **point)
	Get the point of the clip plane.
HRESULT	tfRenderingClipPlane_getNormal (struct tfRenderingClipPlaneHandle *handle, float **normal)
	Get the normal vector of the clip plane.
HRESULT	tfRenderingClipPlane_getEquation (struct tfRenderingClipPlaneHandle *handle, float **pe)
	Get the coefficients of the plane equation of the clip plane.
HRESULT	tfRenderingClipPlane_setEquationE (struct tfRenderingClipPlaneHandle *handle, float *pe)
	Set the coefficients of the plane equation of the clip plane.
HRESULT	tfRenderingClipPlane_setEquationPN (struct tfRenderingClipPlaneHandle *handle, float *point, float *normal)
	Set the coefficients of the plane equation of the clip plane using a point on the plane and its normal.
HRESULT	tfRenderingClipPlane_destroyCP (struct tfRenderingClipPlaneHandle *handle)
	Destroy the clip plane.
HRESULT	tfRenderingClipPlane_destroy (struct tfRenderingClipPlaneHandle *handle)
	Destroy the handle instance.
HRESULT	tfRenderingClipPlanes_len (unsigned int *numCPs)
	Get the number of clip planes.
HRESULT	tfRenderingClipPlanes_item (struct tfRenderingClipPlaneHandle *handle, unsigned int index)
	Get a clip plane by index.
HRESULT	tfRenderingClipPlanes_createE (struct tfRenderingClipPlaneHandle *handle, float *pe)
	Create a clip plane from the coefficients of the equation of the plane.
HRESULT	tfRenderingClipPlanes_createPN (struct tfRenderingClipPlaneHandle *handle, float *point, float *normal)
	Create a clip plane from a point and normal of the plane.

Function Documentation

tfRenderingClipPlane_destroy()

HRESULT tfRenderingClipPlane_destroy

(

struct tfRenderingClipPlaneHandle *

handle

)

Destroy the handle instance.

Parameters

handle

populated handle

Returns

S_OK on success

tfRenderingClipPlane_destroyCP()

HRESULT tfRenderingClipPlane_destroyCP

(

struct tfRenderingClipPlaneHandle *

handle

)

Destroy the clip plane.

Parameters

handle

populated handle

Returns

S_OK on success

tfRenderingClipPlane_getEquation()

HRESULT tfRenderingClipPlane_getEquation	(	struct tfRenderingClipPlaneHandle *	handle,
		float **	pe )

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

Parameters

handle	populated handle
pe	plane equation coefficients

Returns

S_OK on success

tfRenderingClipPlane_getIndex()

HRESULT tfRenderingClipPlane_getIndex	(	struct tfRenderingClipPlaneHandle *	handle,
		int *	index )

Get the index of the clip plane.

Parameters

handle	populated handle
index	index of the clip plane; Less than zero if clip plane has been destroyed.

Returns

S_OK on success

tfRenderingClipPlane_getNormal()

HRESULT tfRenderingClipPlane_getNormal	(	struct tfRenderingClipPlaneHandle *	handle,
		float **	normal )

Get the normal vector of the clip plane.

Parameters

handle	populated handle
normal	normal of the clip plane

Returns

S_OK on success

tfRenderingClipPlane_getPoint()

HRESULT tfRenderingClipPlane_getPoint	(	struct tfRenderingClipPlaneHandle *	handle,
		float **	point )

Get the point of the clip plane.

Parameters

handle	populated handle
point	point of the clip plane

Returns

S_OK on success

tfRenderingClipPlane_setEquationE()

HRESULT tfRenderingClipPlane_setEquationE	(	struct tfRenderingClipPlaneHandle *	handle,
		float *	pe )

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

Parameters

handle	populated handle
pe	plane equation coefficients

Returns

S_OK on success

tfRenderingClipPlane_setEquationPN()

HRESULT tfRenderingClipPlane_setEquationPN	(	struct tfRenderingClipPlaneHandle *	handle,
		float *	point,
		float *	normal )

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

Parameters

handle	populated handle
point	plane point
normal	plane normal vector

Returns

S_OK on success

tfRenderingClipPlanes_createE()

HRESULT tfRenderingClipPlanes_createE	(	struct tfRenderingClipPlaneHandle *	handle,
		float *	pe )

Create a clip plane from the coefficients of the equation of the plane.

Parameters

handle	handle to populate
pe	coefficients of the equation of the plane

Returns

S_OK on success

tfRenderingClipPlanes_createPN()

HRESULT tfRenderingClipPlanes_createPN	(	struct tfRenderingClipPlaneHandle *	handle,
		float *	point,
		float *	normal )

Create a clip plane from a point and normal of the plane.

Parameters

handle	handle to populate
point	point on the clip plane
normal	normal of the clip plane

Returns

S_OK on success

tfRenderingClipPlanes_item()

HRESULT tfRenderingClipPlanes_item	(	struct tfRenderingClipPlaneHandle *	handle,
		unsigned int	index )

Get a clip plane by index.

Parameters

handle	handle to populate
index	index of the clip plane

Returns

S_OK on success

tfRenderingClipPlanes_len()

HRESULT tfRenderingClipPlanes_len

(

unsigned int *

numCPs

)

Get the number of clip planes.

Parameters

numCPs

number of clip planes

Returns

S_OK on success