CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
OdGiAbstractClipBoundary Class Reference

#include <GiAbstractClipBoundary.h>

Inheritance diagram for OdGiAbstractClipBoundary:
OdGiExtendedClipBoundary OdGiInvertedClipBoundary OdGiMultiClipBoundary OdGiPlanarClipBoundary OdGiComplexClipBoundary OdGiMultiClipBoundaryClone

Public Types

enum  BoundaryType {
  kNormal = 0 , kInverted , kExtended , kComplex ,
  kPlanar , kMulti
}
 

Public Member Functions

 ODRX_HEAP_OPERATORS ()
 
 OdGiAbstractClipBoundary ()
 
virtual ~OdGiAbstractClipBoundary ()
 
virtual BoundaryType type () const
 
virtual OdGiAbstractClipBoundaryclone () const
 

Detailed Description

Base class for pass additional 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>

Definition at line 40 of file GiAbstractClipBoundary.h.

Member Enumeration Documentation

◆ BoundaryType

Represents clip boundary types.

Enumerator
kNormal 
kInverted 
kExtended 
kComplex 
kPlanar 
kMulti 

Definition at line 46 of file GiAbstractClipBoundary.h.

Constructor & Destructor Documentation

◆ OdGiAbstractClipBoundary()

OdGiAbstractClipBoundary::OdGiAbstractClipBoundary ( )
inline

Default constructor for the OdGiAbstractClipBoundary class.

Definition at line 61 of file GiAbstractClipBoundary.h.

◆ ~OdGiAbstractClipBoundary()

virtual OdGiAbstractClipBoundary::~OdGiAbstractClipBoundary ( )
inlinevirtual

Destructor for the OdGiAbstractClipBoundary class.

Definition at line 66 of file GiAbstractClipBoundary.h.

Member Function Documentation

◆ clone()

virtual OdGiAbstractClipBoundary * OdGiAbstractClipBoundary::clone ( ) const
inlinevirtual

Returns cloned object.

Returns
Pointer to a new OdGiAbstractClipBoundary instance.

Reimplemented in OdGiInvertedClipBoundary, OdGiExtendedClipBoundary, OdGiComplexClipBoundary, OdGiPlanarClipBoundary, and OdGiMultiClipBoundary.

Definition at line 82 of file GiAbstractClipBoundary.h.

◆ ODRX_HEAP_OPERATORS()

OdGiAbstractClipBoundary::ODRX_HEAP_OPERATORS ( )

◆ type()

virtual BoundaryType OdGiAbstractClipBoundary::type ( ) const
inlinevirtual

Returns type of the inherited boundary.

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

Reimplemented in OdGiInvertedClipBoundary, OdGiExtendedClipBoundary, OdGiComplexClipBoundary, OdGiPlanarClipBoundary, and OdGiMultiClipBoundary.

Definition at line 74 of file GiAbstractClipBoundary.h.


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