OdGiMultiClipBoundary Class Reference

#include <GiAbstractClipBoundary.h>

Inheritance diagram for OdGiMultiClipBoundary:

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

Public Member Functions
	OdGiMultiClipBoundary ()
	~OdGiMultiClipBoundary ()
BoundaryType	type () const
const AbstractClipBoundaryArray &	clipBoundaries () const
void	setClipBoundaries (const AbstractClipBoundaryArray &pClipBoundaries)
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
AbstractClipBoundaryArray	m_ClipBoundaries

Detailed Description

Class to pass multiple clip boundaries at once 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>

Definition at line 407 of file GiAbstractClipBoundary.h.

Member Typedef Documentation

AbstractClipBoundaryArray

typedef OdArray<OdGiAbstractClipBoundary*, OdMemoryAllocator<OdGiAbstractClipBoundary*> > OdGiMultiClipBoundary::AbstractClipBoundaryArray

Defines the type of array of abstract clip boundaries.

Definition at line 413 of file GiAbstractClipBoundary.h.

Constructor & Destructor Documentation

OdGiMultiClipBoundary()

OdGiMultiClipBoundary::OdGiMultiClipBoundary ( )

inline

Default constructor for the OdGiMultiClipBoundary class.

Definition at line 420 of file GiAbstractClipBoundary.h.

~OdGiMultiClipBoundary()

OdGiMultiClipBoundary::~OdGiMultiClipBoundary ( )

inline

Destructor for the OdGiMultiClipBoundary class.

Definition at line 425 of file GiAbstractClipBoundary.h.

Member Function Documentation

clipBoundaries()

const AbstractClipBoundaryArray & OdGiMultiClipBoundary::clipBoundaries ( ) const

inline

Returns array of clip boundaries.

Returns

Array that may contain multiple clip boundaries.

Definition at line 441 of file GiAbstractClipBoundary.h.

clone()

OdGiAbstractClipBoundary * OdGiMultiClipBoundary::clone ( ) const

inlinevirtual

Returns cloned object.

Returns

Pointer to the cloned OdGiMultiClipBoundary object.

Reimplemented from OdGiAbstractClipBoundary.

Definition at line 490 of file GiAbstractClipBoundary.h.

setClipBoundaries()

void OdGiMultiClipBoundary::setClipBoundaries ( const AbstractClipBoundaryArray &  pClipBoundaries )

inline

Setup array of clip boundaries.

Parameters

pClipBoundaries

[in] Input array of clip boundaries.

Definition at line 446 of file GiAbstractClipBoundary.h.

type()

BoundaryType OdGiMultiClipBoundary::type ( ) const

inlinevirtual

Returns type of the inherited boundary.

Returns

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

Reimplemented from OdGiAbstractClipBoundary.

Definition at line 433 of file GiAbstractClipBoundary.h.

Member Data Documentation

m_ClipBoundaries

AbstractClipBoundaryArray OdGiMultiClipBoundary::m_ClipBoundaries

protected

Definition at line 415 of file GiAbstractClipBoundary.h.

---

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

• GiAbstractClipBoundary.h