CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdGsBackground Class Referenceabstract

#include <GsBackground.h>

Inheritance diagram for OdGsBackground:
OdRxObject OdGsNestedBackground

Public Types

enum  BackgroundType {
  kSolidBackground = 0 , kGradientBackground = 1 , kImageBackground = 2 , kGroundPlaneBackground = 3 ,
  kSkyBackground = 4 , kIBLBackground = 5 , kEnvironmentBackground = 6 , kCustomBackground = 7
}
 

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGsBackground)
 
virtual BackgroundType type () const =0
 
virtual void display (OdGsBaseVectorizer &view, const OdGiDrawable *pDrawable, OdGiBackgroundTraitsData *pBackgroundTraits, OdGsPropertiesDirectRenderOutput *pdro=NULL)=0
 
virtual void nestedBackgroundDisplay (OdGsBaseVectorizer &view, const OdGiDrawable *pDrawable, OdGiBackgroundTraitsData *pBackgroundTraits, OdGsPropertiesDirectRenderOutput *pdro=NULL)
 
virtual void setNestedBackground (OdGsNestedBackground *)
 
virtual OdGsNestedBackgroundgetNestedBackground () const
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
static void rxInit ()
 
static void rxUninit ()
 

Detailed Description

Corresponding C++ library: TD_Gs <group OdGs_Classes>

Definition at line 55 of file GsBackground.h.

Member Enumeration Documentation

◆ BackgroundType

Enumerator
kSolidBackground 
kGradientBackground 
kImageBackground 
kGroundPlaneBackground 
kSkyBackground 
kIBLBackground 
kEnvironmentBackground 
kCustomBackground 

Definition at line 61 of file GsBackground.h.

Member Function Documentation

◆ display()

virtual void OdGsBackground::display ( OdGsBaseVectorizer & view,
const OdGiDrawable * pDrawable,
OdGiBackgroundTraitsData * pBackgroundTraits,
OdGsPropertiesDirectRenderOutput * pdro = NULL )
pure virtual

◆ getNestedBackground()

virtual OdGsNestedBackground * OdGsBackground::getNestedBackground ( ) const
inlinevirtual

Definition at line 89 of file GsBackground.h.

◆ nestedBackgroundDisplay()

virtual void OdGsBackground::nestedBackgroundDisplay ( OdGsBaseVectorizer & view,
const OdGiDrawable * pDrawable,
OdGiBackgroundTraitsData * pBackgroundTraits,
OdGsPropertiesDirectRenderOutput * pdro = NULL )
inlinevirtual

Implements OdGsNestedBackground.

Definition at line 80 of file GsBackground.h.

◆ ODRX_DECLARE_MEMBERS()

OdGsBackground::ODRX_DECLARE_MEMBERS ( OdGsBackground )

◆ setNestedBackground()

virtual void OdGsBackground::setNestedBackground ( OdGsNestedBackground * )
inlinevirtual

Definition at line 88 of file GsBackground.h.

◆ type()

virtual BackgroundType OdGsBackground::type ( ) const
pure virtual

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