CFx SDK Documentation  2023 SP0
Public Member Functions | Protected Member Functions | List of all members
OdGsBackgroundProperties Class Reference

#include <GsBackgroundProperties.h>

Inheritance diagram for OdGsBackgroundProperties:
OdGsProperties OdGsNestedBackground OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGsBackgroundProperties)
 
 OdGsBackgroundProperties ()
 
 ~OdGsBackgroundProperties ()
 
OdGiSolidBackgroundTraitsData * solidBackgroundTraitsData () const
 
OdGiGradientBackgroundTraitsData * gradientBackgroundTraitsData () const
 
OdGiImageBackgroundTraitsData * imageBackgroundTraitsData () const
 
OdGiGroundPlaneBackgroundTraitsData * groundPlaneBackgroundTraitsData () const
 
OdGiSkyBackgroundTraitsData * skyBackgroundTraitsData () const
 
OdGiIBLBackgroundTraitsData * iblBackgroundTraitsData () const
 
OdGiBackgroundTraitsData * backgroundTraitsData () const
 
OdGiDrawable::DrawableType backgroundType () const
 
const OdGsBackgroundProperties * secondaryBackground () const
 
OdGsBackgroundProperties * secondaryBackground ()
 
bool isTraitsModified ()
 
void clearTraits ()
 
virtual PropertiesType propertiesType () const
 
virtual OdSmartPtr< OdGsProperties > propertiesForType (PropertiesType type) const
 
virtual void update (const OdGiDrawable *pUnderlyingDrawable, OdGsViewImpl *view, OdUInt32 incFlags=kAll)
 
virtual void display (OdGsBaseVectorizer &view, OdGsPropertiesDirectRenderOutput *pdro=NULL, OdUInt32 incFlags=kAll)
 
- Public Member Functions inherited from OdGsProperties
 ODRX_DECLARE_MEMBERS (OdGsProperties)
 
 OdGsProperties ()
 
void setOpenDrawableFn (OdGiDrawablePtr(*fn)(OdDbStub *))
 
void setUnderlyingDrawable (const OdGiDrawable *pUnderlyingDrawable, OdGiContext *ctx)
 
OdGiDrawablePtr underlyingDrawable () const
 
bool isUnderlyingDrawableChanged (const OdGiDrawable *pUnderlyingDrawable) const
 
bool hasUnderlyingDrawable () const
 
bool isUnderlyingDrawablePersistent () const
 
OdDbStub * underlyingDrawableId () const
 
OdGiDrawable::DrawableType underlyingDrawableType () const
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () 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
 

Protected Member Functions

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

Additional Inherited Members

- Public Types inherited from OdGsProperties
enum  PropertiesType {
  kViewport = 1 , kBackground = (1 << 1) , kVisualStyle = (1 << 2) , kRenderEnvironment = (1 << 3) ,
  kRenderSettings = (1 << 4) , kDeviceSimple = 0 , kDeviceBackground = 3 , kDeviceNormal = 7 ,
  kDeviceRender = 0xFF , kAll = 0xFF
}
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 
- Protected Attributes inherited from OdGsProperties
void * m_pUnderlyingDrawable
 
const OdGiDrawable * m_pInconsistentDrawable
 
OdGiContext * m_context
 
OdGiDrawablePtr(* m_pOpenDrawableFn )(OdDbStub *id)
 
bool m_bDrawablePersistent
 
OdGiDrawable::DrawableType m_dType
 

Detailed Description

<group OdGs_Classes>

Definition at line 35 of file GsBackgroundProperties.h.

Constructor & Destructor Documentation

◆ OdGsBackgroundProperties()

OdGsBackgroundProperties::OdGsBackgroundProperties ( )

◆ ~OdGsBackgroundProperties()

OdGsBackgroundProperties::~OdGsBackgroundProperties ( )

Member Function Documentation

◆ backgroundTraitsData()

OdGiBackgroundTraitsData* OdGsBackgroundProperties::backgroundTraitsData ( ) const
inline

Definition at line 60 of file GsBackgroundProperties.h.

◆ backgroundType()

OdGiDrawable::DrawableType OdGsBackgroundProperties::backgroundType ( ) const
inline

Definition at line 62 of file GsBackgroundProperties.h.

◆ clearTraits()

void OdGsBackgroundProperties::clearTraits ( )

◆ display()

virtual void OdGsBackgroundProperties::display ( OdGsBaseVectorizer &  view,
OdGsPropertiesDirectRenderOutput *  pdro = NULL,
OdUInt32  incFlags = kAll 
)
virtual

Implements OdGsProperties.

◆ gradientBackgroundTraitsData()

OdGiGradientBackgroundTraitsData* OdGsBackgroundProperties::gradientBackgroundTraitsData ( ) const
inline

Definition at line 55 of file GsBackgroundProperties.h.

◆ groundPlaneBackgroundTraitsData()

OdGiGroundPlaneBackgroundTraitsData* OdGsBackgroundProperties::groundPlaneBackgroundTraitsData ( ) const
inline

Definition at line 57 of file GsBackgroundProperties.h.

◆ iblBackgroundTraitsData()

OdGiIBLBackgroundTraitsData* OdGsBackgroundProperties::iblBackgroundTraitsData ( ) const
inline

Definition at line 59 of file GsBackgroundProperties.h.

◆ imageBackgroundTraitsData()

OdGiImageBackgroundTraitsData* OdGsBackgroundProperties::imageBackgroundTraitsData ( ) const
inline

Definition at line 56 of file GsBackgroundProperties.h.

◆ isTraitsModified()

bool OdGsBackgroundProperties::isTraitsModified ( )

◆ nestedBackgroundDisplay()

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

Implements OdGsNestedBackground.

◆ ODRX_DECLARE_MEMBERS()

OdGsBackgroundProperties::ODRX_DECLARE_MEMBERS ( OdGsBackgroundProperties  )

◆ propertiesForType()

virtual OdSmartPtr<OdGsProperties> OdGsBackgroundProperties::propertiesForType ( PropertiesType  type) const
virtual

Reimplemented from OdGsProperties.

◆ propertiesType()

virtual PropertiesType OdGsBackgroundProperties::propertiesType ( ) const
inlinevirtual

Implements OdGsProperties.

Definition at line 72 of file GsBackgroundProperties.h.

◆ secondaryBackground() [1/2]

OdGsBackgroundProperties* OdGsBackgroundProperties::secondaryBackground ( )
inline

Definition at line 64 of file GsBackgroundProperties.h.

◆ secondaryBackground() [2/2]

const OdGsBackgroundProperties* OdGsBackgroundProperties::secondaryBackground ( ) const
inline

Definition at line 63 of file GsBackgroundProperties.h.

◆ skyBackgroundTraitsData()

OdGiSkyBackgroundTraitsData* OdGsBackgroundProperties::skyBackgroundTraitsData ( ) const
inline

Definition at line 58 of file GsBackgroundProperties.h.

◆ solidBackgroundTraitsData()

OdGiSolidBackgroundTraitsData* OdGsBackgroundProperties::solidBackgroundTraitsData ( ) const
inline

Definition at line 54 of file GsBackgroundProperties.h.

◆ update()

virtual void OdGsBackgroundProperties::update ( const OdGiDrawable *  pUnderlyingDrawable,
OdGsViewImpl *  view,
OdUInt32  incFlags = kAll 
)
virtual

Implements OdGsProperties.

The documentation for this class was generated from the following file:
Generated on Thu Feb 24 2022 15:11:03