CFx SDK Documentation  2023 SP0
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
OdGiPlanarClipBoundary Class Reference

#include <GiAbstractClipBoundary.h>

Inheritance diagram for OdGiPlanarClipBoundary:
OdGiAbstractClipBoundary

Classes

struct  ClipPlane
 

Public Types

typedef OdArray< ClipPlaneClipPlaneArray
 
- Public Types inherited from OdGiAbstractClipBoundary
enum  BoundaryType {
  kNormal = 0 , kInverted , kExtended , kComplex ,
  kPlanar
}
 

Public Member Functions

 OdGiPlanarClipBoundary ()
 
 ~OdGiPlanarClipBoundary ()
 
BoundaryType type () const
 
const ClipPlaneArrayclipPlanes () const
 
void setClipPlanes (const ClipPlaneArray &pClipPlanes)
 
OdGiSectionGeometryOutputsectionGeometryOutput () const
 
void setSectionGeometryOutput (OdGiSectionGeometryOutput *pSectionOutput)
 
OdGiAbstractClipBoundaryclone () const
 
- Public Member Functions inherited from OdGiAbstractClipBoundary
 ODRX_HEAP_OPERATORS ()
 
 OdGiAbstractClipBoundary ()
 
virtual ~OdGiAbstractClipBoundary ()
 

Protected Attributes

ClipPlaneArray m_ClipPlanes
 
OdGiSectionGeometryOutputPtr m_pSectionOutput
 

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>

Definition at line 182 of file GiAbstractClipBoundary.h.

Member Typedef Documentation

◆ ClipPlaneArray

Defines the type of array of clipping planes.

Definition at line 206 of file GiAbstractClipBoundary.h.

Constructor & Destructor Documentation

◆ OdGiPlanarClipBoundary()

OdGiPlanarClipBoundary::OdGiPlanarClipBoundary ( )
inline

Definition at line 211 of file GiAbstractClipBoundary.h.

◆ ~OdGiPlanarClipBoundary()

OdGiPlanarClipBoundary::~OdGiPlanarClipBoundary ( )
inline

Definition at line 212 of file GiAbstractClipBoundary.h.

Member Function Documentation

◆ clipPlanes()

const ClipPlaneArray& OdGiPlanarClipBoundary::clipPlanes ( ) const
inline

Returns array of clipping planes.

Definition at line 222 of file GiAbstractClipBoundary.h.

◆ clone()

OdGiAbstractClipBoundary* OdGiPlanarClipBoundary::clone ( ) const
inlinevirtual

Returns cloned object.

Reimplemented from OdGiAbstractClipBoundary.

Definition at line 242 of file GiAbstractClipBoundary.h.

◆ sectionGeometryOutput()

OdGiSectionGeometryOutput* OdGiPlanarClipBoundary::sectionGeometryOutput ( ) const
inline

Returns optional clipping section geometry output.

Definition at line 232 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 227 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 237 of file GiAbstractClipBoundary.h.

◆ type()

BoundaryType OdGiPlanarClipBoundary::type ( ) const
inlinevirtual

Returns type of the inherited boundary.

Reimplemented from OdGiAbstractClipBoundary.

Definition at line 217 of file GiAbstractClipBoundary.h.

Member Data Documentation

◆ m_ClipPlanes

ClipPlaneArray OdGiPlanarClipBoundary::m_ClipPlanes
protected

Definition at line 208 of file GiAbstractClipBoundary.h.

◆ m_pSectionOutput

OdGiSectionGeometryOutputPtr OdGiPlanarClipBoundary::m_pSectionOutput
mutableprotected

Definition at line 209 of file GiAbstractClipBoundary.h.


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