OdGiPlanarClipBoundary Class Reference

#include <GiAbstractClipBoundary.h>

Inheritance diagram for OdGiPlanarClipBoundary:

Classes
struct	ClipPlane

Public Types
typedef OdArray< ClipPlane >	ClipPlaneArray
Public Types inherited from OdGiAbstractClipBoundary
enum	BoundaryType {   kNormal = 0 , kInverted , kExtended , kComplex ,   kPlanar , kMulti }

Public Member Functions
	OdGiPlanarClipBoundary ()
	~OdGiPlanarClipBoundary ()
BoundaryType	type () const
const ClipPlaneArray &	clipPlanes () const
void	setClipPlanes (const ClipPlaneArray &pClipPlanes)
OdGiSectionGeometryOutput *	sectionGeometryOutput () const
void	setSectionGeometryOutput (OdGiSectionGeometryOutput *pSectionOutput)
OdGiCuttedGeometryOutput *	cuttedGeometryOutput () const
void	setCuttedGeometryOutput (OdGiCuttedGeometryOutput *pCuttedOutput)
OdGiAbstractClipBoundary *	clone () const
Public Member Functions inherited from OdGiAbstractClipBoundary
	ODRX_HEAP_OPERATORS ()
	OdGiAbstractClipBoundary ()
virtual	~OdGiAbstractClipBoundary ()
virtual BoundaryType	type () const
virtual OdGiAbstractClipBoundary *	clone () const

Protected Attributes
ClipPlaneArray	m_ClipPlanes
OdGiSectionGeometryOutputPtr	m_pSectionOutput
OdGiCuttedGeometryOutputPtr	m_pCuttedOutput

Detailed Description

Class to pass planar clip boundary information from OdGiDrawable objects to the underlying OdGi system. Corresponding C++ library: TD_Gi <group OdGi_Classes>

See also

<link gi_clipping_engine, Work with the Clipping Engine>

<link tv_planarClip, Work with Planar Clipping>

Definition at line 256 of file GiAbstractClipBoundary.h.

Member Typedef Documentation

ClipPlaneArray

typedef OdArray<ClipPlane> OdGiPlanarClipBoundary::ClipPlaneArray

Defines the type of array of clipping planes.

Definition at line 322 of file GiAbstractClipBoundary.h.

Constructor & Destructor Documentation

OdGiPlanarClipBoundary()

OdGiPlanarClipBoundary::OdGiPlanarClipBoundary ( )

inline

Default constructor for the OdGiPlanarClipBoundary class.

Definition at line 331 of file GiAbstractClipBoundary.h.

~OdGiPlanarClipBoundary()

OdGiPlanarClipBoundary::~OdGiPlanarClipBoundary ( )

inline

Destructor for the OdGiPlanarClipBoundary class.

Definition at line 336 of file GiAbstractClipBoundary.h.

Member Function Documentation

clipPlanes()

const ClipPlaneArray & OdGiPlanarClipBoundary::clipPlanes ( ) const

inline

Returns array of clipping planes.

Returns

Array that may contain multiple clipping planes.

Definition at line 352 of file GiAbstractClipBoundary.h.

clone()

OdGiAbstractClipBoundary * OdGiPlanarClipBoundary::clone ( ) const

inlinevirtual

Returns cloned object.

Returns

Pointer to a new OdGiAbstractClipBoundary instance.

Reimplemented from OdGiAbstractClipBoundary.

Definition at line 391 of file GiAbstractClipBoundary.h.

cuttedGeometryOutput()

OdGiCuttedGeometryOutput * OdGiPlanarClipBoundary::cuttedGeometryOutput ( ) const

inline

Returns optional cutted geometry output.

Returns

Optional cut geometry output.

Definition at line 378 of file GiAbstractClipBoundary.h.

sectionGeometryOutput()

OdGiSectionGeometryOutput * OdGiPlanarClipBoundary::sectionGeometryOutput ( ) const

inline

Returns optional clipping section geometry output.

Returns

Optional geometry sections output.

Definition at line 365 of file GiAbstractClipBoundary.h.

setClipPlanes()

void OdGiPlanarClipBoundary::setClipPlanes ( const ClipPlaneArray &  pClipPlanes )

inline

Setup array of clipping planes.

Parameters

pClipPlanes

[in] Input array of clipping planes.

Definition at line 357 of file GiAbstractClipBoundary.h.

setCuttedGeometryOutput()

void OdGiPlanarClipBoundary::setCuttedGeometryOutput ( OdGiCuttedGeometryOutput *  pCuttedOutput )

inline

Setup optional cutted geometry output.

Parameters

pCuttedOutput

[in] Input pointer onto cutted geometry output.

Definition at line 383 of file GiAbstractClipBoundary.h.

setSectionGeometryOutput()

void OdGiPlanarClipBoundary::setSectionGeometryOutput ( OdGiSectionGeometryOutput *  pSectionOutput )

inline

Setup optional clipping section geometry output.

Parameters

pSectionOutput

[in] Input pointer onto section geometry output.

Definition at line 370 of file GiAbstractClipBoundary.h.

type()

BoundaryType OdGiPlanarClipBoundary::type ( ) const

inlinevirtual

Returns type of the inherited boundary.

Returns

Boundary type as a OdGiAbstractClipBoundary::BoundaryType value which is the OdGiAbstractClipBoundary::kPlanar for this object.

Reimplemented from OdGiAbstractClipBoundary.

Definition at line 344 of file GiAbstractClipBoundary.h.

Member Data Documentation

m_ClipPlanes

ClipPlaneArray OdGiPlanarClipBoundary::m_ClipPlanes

protected

Definition at line 324 of file GiAbstractClipBoundary.h.

m_pCuttedOutput

OdGiCuttedGeometryOutputPtr OdGiPlanarClipBoundary::m_pCuttedOutput

mutableprotected

Definition at line 326 of file GiAbstractClipBoundary.h.

m_pSectionOutput

OdGiSectionGeometryOutputPtr OdGiPlanarClipBoundary::m_pSectionOutput

mutableprotected

Definition at line 325 of file GiAbstractClipBoundary.h.

---

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

• GiAbstractClipBoundary.h