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

#include <GsRenderSettingsProperties.h>

Inheritance diagram for OdGsRenderEnvironmentProperties:
OdGsProperties OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGsRenderEnvironmentProperties)
 
 OdGsRenderEnvironmentProperties ()
 
 ~OdGsRenderEnvironmentProperties ()
 
OdGiRenderEnvironmentTraitsDatarenderEnvironmentTraitsData () const
 
bool isTraitsModified ()
 
void clearTraits ()
 
virtual PropertiesType propertiesType () const
 
virtual OdSmartPtr< OdGsPropertiespropertiesForType (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
 
virtual PropertiesType propertiesType () const =0
 
virtual OdSmartPtr< OdGsPropertiespropertiesForType (PropertiesType) const
 
virtual void update (const OdGiDrawable *pUnderlyingDrawable, OdGsViewImpl *view, OdUInt32 incFlags=kAll)=0
 
virtual void display (OdGsBaseVectorizer &view, OdGsPropertiesDirectRenderOutput *pdro=NULL, OdUInt32 incFlags=kAll)=0
 
- 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

- 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 = 31 , kAll = 31
}
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Attributes inherited from OdGsProperties
voidm_pUnderlyingDrawable
 
const OdGiDrawablem_pInconsistentDrawable
 
OdGiContextm_context
 
OdGiDrawablePtr(* m_pOpenDrawableFn )(OdDbStub *id)
 
bool m_bDrawablePersistent
 
OdGiDrawable::DrawableType m_dType
 

Detailed Description

<group OdGs_Classes>

Definition at line 39 of file GsRenderSettingsProperties.h.

Constructor & Destructor Documentation

◆ OdGsRenderEnvironmentProperties()

OdGsRenderEnvironmentProperties::OdGsRenderEnvironmentProperties ( )

Default constructor for the OdGsRenderEnvironmentProperties class. Creates object with OdGiRenderEnvironmentTraitsData object pointer that points to NULL.

◆ ~OdGsRenderEnvironmentProperties()

OdGsRenderEnvironmentProperties::~OdGsRenderEnvironmentProperties ( )

Destructor for the OdGsRenderEnvironmentProperties class. Clears underlying OdGiRenderEnvironmentTraitsData object and destroys this object.

Member Function Documentation

◆ clearTraits()

void OdGsRenderEnvironmentProperties::clearTraits ( )

Clears render environment traits of the underlying OdGiRenderEnvironmentTraitsData object.

◆ display()

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

Implements OdGsProperties.

◆ isTraitsModified()

bool OdGsRenderEnvironmentProperties::isTraitsModified ( )

Checks whether render environment traits are modified.

Returns
true if at least one of the following conditions is true: Pointer to render environment traits (OdGiRenderEnvironmentTraitsData) is NULL This object has no underlying drawable Render environment traits data has been modified In other cases this method returns false.

◆ ODRX_DECLARE_MEMBERS()

OdGsRenderEnvironmentProperties::ODRX_DECLARE_MEMBERS ( OdGsRenderEnvironmentProperties  )

◆ propertiesForType()

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

Retrieves smart pointer to the properties by the specified type.

Parameters
type[in] Property type.
Returns
smart pointer to this object is the passed type is kRenderEnvironment, otherwise returns smart pointer to generic OdGsProperties object.

Reimplemented from OdGsProperties.

◆ propertiesType()

virtual PropertiesType OdGsRenderEnvironmentProperties::propertiesType ( ) const
inlinevirtual

Retrieves the property type.

Implements OdGsProperties.

Definition at line 82 of file GsRenderSettingsProperties.h.

◆ renderEnvironmentTraitsData()

OdGiRenderEnvironmentTraitsData * OdGsRenderEnvironmentProperties::renderEnvironmentTraitsData ( ) const
inline

Returns pointer to the OdGiRenderEnvironmentTraitsData object that represents render environment traits.

Definition at line 59 of file GsRenderSettingsProperties.h.

◆ update()

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

Implements OdGsProperties.


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