CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | List of all members
OdGsBaseModule Class Referenceabstract

#include <GsBaseModule.h>

Inheritance diagram for OdGsBaseModule:
OdGsModule OdRxModule OdRxObject BaseTrVecModule

Classes

class  GsViewUpdateEvent
 

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGsBaseModule)
 
void fire_viewToBeDestroyed (OdGsView *pView)
 
OdGsDevicePtr createDevice ()
 
OdGsDevicePtr createBitmapDevice ()
 
OdSmartPtr< OdGsViewImpl > createView ()
 
OdSmartPtr< OdGsViewImpl > createBitmapView ()
 
void addReactor (OdGsReactor *pReactor)
 
void removeReactor (OdGsReactor *pReactor)
 
void initApp ()
 
void uninitApp ()
 
- Public Member Functions inherited from OdGsModule
 ODRX_DECLARE_MEMBERS (OdGsModule)
 
virtual OdGsDevicePtr createDevice ()=0
 
virtual OdGsDevicePtr createBitmapDevice ()
 
virtual void addReactor (OdGsReactor *pReactor)=0
 
virtual void removeReactor (OdGsReactor *pReactor)=0
 
- Public Member Functions inherited from OdRxModule
 ODRX_DECLARE_MEMBERS (OdRxModule)
 
virtual void * sysData ()=0
 
virtual void deleteModule ()=0
 
virtual void initApp ()=0
 
virtual void uninitApp ()=0
 
virtual OdString moduleName () const =0
 
- 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

void fire_viewWasCreated (OdGsView *pView)
 
void fire_viewToBeUpdated (OdGsView *pView, int flags)
 
void fire_viewWasUpdated (OdGsView *pView, int flags)
 
void fire_gsToBeUnloaded (OdGsModule *pModule)
 
virtual OdSmartPtr< OdGsBaseVectorizeDevice > createDeviceObject ()=0
 
virtual OdSmartPtr< OdGsViewImpl > createViewObject ()=0
 
virtual OdSmartPtr< OdGsBaseVectorizeDevice > createBitmapDeviceObject ()
 
virtual OdSmartPtr< OdGsViewImpl > createBitmapViewObject ()
 
 OdGsBaseModule ()
 
void onFinalRelease ()
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 

Detailed Description

This class provides management of bitmapped GUI display windows.

Corresponding C++ library: Gs <group OdGs_Classes>

Definition at line 40 of file GsBaseModule.h.

Constructor & Destructor Documentation

◆ OdGsBaseModule()

OdGsBaseModule::OdGsBaseModule ( )
protected

Member Function Documentation

◆ addReactor()

void OdGsBaseModule::addReactor ( OdGsReactor *  pReactor)
virtual

Adds the specified reactor to this object's reactor list.

Parameters
pReactor[in] Pointer to the reactor object.

Implements OdGsModule.

◆ createBitmapDevice()

OdGsDevicePtr OdGsBaseModule::createBitmapDevice ( )
virtual

Creates a new OdGsBaseVectorizeDevice object, and associates it with this BaseModule object.

Returns
Returns a SmartPointer to the newly created object.

Reimplemented from OdGsModule.

◆ createBitmapDeviceObject()

virtual OdSmartPtr< OdGsBaseVectorizeDevice > OdGsBaseModule::createBitmapDeviceObject ( )
protectedvirtual

Creates a new OdGsBaseVectorizeDevice object, and associates it with this BaseModule object.

Returns
Returns a SmartPointer to the newly created object.
Remarks
This default implementation simply returns NULL which means that the option is not supported.

◆ createBitmapView()

OdSmartPtr< OdGsViewImpl > OdGsBaseModule::createBitmapView ( )

Creates a new OdGsBaseVectorizeView object, and associates it with this BaseModule object.

Returns
Returns a SmartPointer to the newly created object.

◆ createBitmapViewObject()

virtual OdSmartPtr< OdGsViewImpl > OdGsBaseModule::createBitmapViewObject ( )
protectedvirtual

Creates a new OdGsBaseVectorizeView object, and associates it with this BaseModule object.

Returns
Returns a SmartPointer to the newly created object.
Remarks
This default implementation simply returns NULL which means that the option is not supported.

◆ createDevice()

OdGsDevicePtr OdGsBaseModule::createDevice ( )
virtual

Creates a new OdGsDevice object, and associates it with this BaseModule object.

Returns
Returns a SmartPointer to the newly created object.

Implements OdGsModule.

◆ createDeviceObject()

virtual OdSmartPtr< OdGsBaseVectorizeDevice > OdGsBaseModule::createDeviceObject ( )
protectedpure virtual

Creates a new OdGsBaseVectorizeDevice object, and associates it with this BaseModule object.

Returns
Returns a SmartPointer to the newly created object.

◆ createView()

OdSmartPtr< OdGsViewImpl > OdGsBaseModule::createView ( )

Creates a new OdGsViewImpl object, and associates it with this BaseModule object.

Returns
Returns a SmartPointer to the newly created object.

◆ createViewObject()

virtual OdSmartPtr< OdGsViewImpl > OdGsBaseModule::createViewObject ( )
protectedpure virtual

Creates a new OdGsViewImpl object, and associates it with this BaseModule object.

Returns
Returns a SmartPointer to the newly created object.

◆ fire_gsToBeUnloaded()

void OdGsBaseModule::fire_gsToBeUnloaded ( OdGsModule *  pModule)
protected

Notifies connected reactors that the specified OdGsModule object is about to be unloaded.

Parameters
pModule[in] Pointer to the GsModule object.
Remarks
This function is called before the operation.

◆ fire_viewToBeDestroyed()

void OdGsBaseModule::fire_viewToBeDestroyed ( OdGsView *  pView)

Notifies connected reactors that the specified View object is about to be created.

Parameters
pView[in] Pointer to the OdGsView object.
Remarks
This function is called before the operation.

◆ fire_viewToBeUpdated()

void OdGsBaseModule::fire_viewToBeUpdated ( OdGsView *  pView,
int  flags 
)
protected

Notification function called before OdGsView properties are updated.

Parameters
pView[in] Pointer to the OdGsView object.
flags[in] Bitcoded flags of type ViewUpdateFlags depending on which properties are effected.

◆ fire_viewWasCreated()

void OdGsBaseModule::fire_viewWasCreated ( OdGsView *  pView)
protected

Notifies connected reactors that the specified OdGsView object was created.

Parameters
pView[in] Pointer to the OdGsView object.
Remarks
This function is called after the operation.

◆ fire_viewWasUpdated()

void OdGsBaseModule::fire_viewWasUpdated ( OdGsView *  pView,
int  flags 
)
protected

Notification function called after OdGsView properties are updated.

Parameters
pView[in] Pointer to the OdGsView object.
flags[in] Bitcoded flags of type ViewUpdateFlags depending on which properties are effected.

◆ initApp()

void OdGsBaseModule::initApp ( )
virtual

Notification function called at the start of the client application.

Remarks
The user override of this function should register any custom objects defined in the custom application, using the OdRxObject::rxInit function. It should also register custom commands defined in the module.

Implements OdRxModule.

Reimplemented in BaseTrVecModule.

◆ ODRX_DECLARE_MEMBERS()

OdGsBaseModule::ODRX_DECLARE_MEMBERS ( OdGsBaseModule  )

◆ onFinalRelease()

void OdGsBaseModule::onFinalRelease ( )
protected

Notification function called whenever this BaseModule object is about to be released.

◆ removeReactor()

void OdGsBaseModule::removeReactor ( OdGsReactor *  pReactor)
virtual

Removes the specified reactor from this object's reactor list.

Parameters
pReactor[in] Pointer to the reactor object.

Implements OdGsModule.

◆ uninitApp()

void OdGsBaseModule::uninitApp ( )
virtual

Notification function called at the end of the client application.

Remarks
The user override of this function should unregister any custom objects defined in the custom application, using the OdRxObject::rxUninit function. It should also remove any custom commands that were registered in the initApp function.

Implements OdRxModule.

Reimplemented in BaseTrVecModule.

The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:31:23