VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::DtCigiSimEntityComponentPublisherBase Class Referenceabstract

#include <cigiSimEntityComponentPublisherBase.h>

Inheritance diagram for makVre::DtCigiSimEntityComponentPublisherBase:
[legend]

Public Member Functions

 DtCigiSimEntityComponentPublisherBase ()
 
virtual ~DtCigiSimEntityComponentPublisherBase () override
 
virtual DtCigiSimEntityPublisher::Sptr parentEntity ()
 
virtual DtSimObjectReference simObject ()
 
virtual Cigi_uint16 cigiId () const =0
 
virtual std::string sharedKey () override
 
- Public Member Functions inherited from makVre::DtSpSubClass< DtCigiSimEntityComponentPublisherBase, DtCigiPublisherBase >
 DtSpSubClass ()
 
virtual ~DtSpSubClass ()
 
Sptr self ()
 
std::string type () const override
 
- Public Member Functions inherited from makVre::DtCigiPublisherBase
 DtCigiPublisherBase ()
 
virtual ~DtCigiPublisherBase () override
 
DtCigiDataBaseshared ()
 
DtCigiDataBase *const shared () const
 
virtual bool init () override
 
virtual void setEnabled (bool enabled)
 
virtual bool enabled () const
 
virtual void tick (double dt)
 
template<class CHILD_T>
std::shared_ptr< CHILD_T > addNewChild (const std::string &name="")
 
virtual bool addChild (Sptr child) override
 
virtual void publish (CigiOutgoingMsg &out)
 
virtual void setNeedsReceiptConfirmation (bool needs)
 
virtual bool needsReceiptConfirmation () const
 
virtual void receiptConfirmed ()
 
virtual double lastSent ()
 
virtual void markDirty (bool childrenToo=false)
 
virtual void markClean (bool childrenToo=false)
 
- Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
 DtSpSubClass ()
 
Sptr self ()
 
- Public Member Functions inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
 DtTreeClass ()
 
virtual ~DtTreeClass () override
 
virtual void setOwnsChildren (bool owns)
 
virtual bool ownsChildren ()
 
virtual bool removeChild (Sptr child)
 
virtual void removeAllChildren ()
 
virtual bool forEachChild (ForChildFn fn)
 
virtual Sptr findChild (FindChildFn fn)
 
virtual Sptr findChild (const std::string &name)
 
virtual bool isChild (Sptr child)
 
virtual unsigned int numChildren ()
 
virtual bool hasChildren ()
 
virtual Sptr parent ()
 
- Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
 DtSpSubClass ()
 
Sptr self ()
 
- Public Member Functions inherited from makVre::DtCigiObjectBase
 DtCigiObjectBase ()
 
virtual ~DtCigiObjectBase () override
 
CigiDatacigi ()
 
CigiData *const cigi () const
 
virtual Cigi_uint16 cigiType ()
 
virtual Sptr setSession (DtCigiSession &session)
 
virtual DtCigiSessionsession () const
 
virtual unsigned int sessionVersion () const
 
virtual void markDirty ()
 
virtual void markClean ()
 
virtual bool isDirty () const
 
- Public Member Functions inherited from makVre::DtSpSubClass< DtCigiObjectBase >
 DtSpSubClass ()
 
Sptr self ()
 
- Public Member Functions inherited from makVre::DtSpObject
 DtSpObject ()
 
virtual ~DtSpObject ()
 
Sptr self ()
 
virtual void setName (const std::string &name)
 
virtual std::string name () const
 

Protected Member Functions

virtual void initCigi () override
 
virtual void setCigiId (Cigi_uint16 id)=0
 
- Protected Member Functions inherited from makVre::DtCigiPublisherBase
virtual void setupShared ()
 
virtual bool verifySharedType ()=0
 
virtual void initShared ()
 
virtual void updateShared ()
 
virtual void updateCigi ()
 
virtual void write (CigiOutgoingMsg &out)
 
virtual void createChildren ()
 
virtual void tickChildren (double dt)
 
virtual void publishChildren (CigiOutgoingMsg &out)
 
- Protected Member Functions inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
virtual void setParent (Sptr parent)
 
virtual void pruneChildren ()
 
- Protected Member Functions inherited from makVre::DtCigiObjectBase
virtual DtCigiDataBasecreateCigi ()=0
 
DtCigiDataBasecigiBase ()
 
DtCigiDataBase *const cigiBase () const
 
template<typename VALUE_T>
bool updateValue (VALUE_T *value, VALUE_T source)
 

Additional Inherited Members

- Public Types inherited from makVre::DtSpSubClass< DtCigiSimEntityComponentPublisherBase, DtCigiPublisherBase >
using Super
 
using Ptr
 
using Sptr
 
using Wptr
 
- Public Types inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
using Super
 
using Ptr
 
using Sptr
 
using Wptr
 
- Public Types inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
using Sptr
 
using ForChildFn
 
using FindChildFn
 
- Public Types inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
using Super
 
using Ptr
 
using Sptr
 
using Wptr
 
- Public Types inherited from makVre::DtCigiObjectBase
using Cigi = CigiBasePacket
 
using CigiData = DtCigiDataTemplate<CigiBasePacket, DtCigiObjectBase>
 
using CigiBasePtr = std::shared_ptr<DtCigiDataBase>
 
- Public Types inherited from makVre::DtSpSubClass< DtCigiObjectBase >
using Super
 
using Ptr
 
using Sptr
 
using Wptr
 
- Public Types inherited from makVre::DtSpObject
using Ptr = DtSpObject*
 
using Sptr = std::shared_ptr<DtSpObject>
 
using Wptr = std::weak_ptr<DtSpObject>
 
- Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiSimEntityComponentPublisherBase, DtCigiPublisherBase >
static std::string Type ()
 
static std::shared_ptr< DtCigiSimEntityComponentPublisherBasecreate ()
 
static void registerCreator ()
 
static std::shared_ptr< DtCigiSimEntityComponentPublisherBasecreateVersion (unsigned int version)
 
static void registerCreatorVersion (unsigned int version)
 
- Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
static std::string Type ()
 
static std::shared_ptr< DtCigiPublisherBasecreate ()
 
static void registerCreator ()
 
static std::shared_ptr< DtCigiPublisherBasecreateVersion (unsigned int version)
 
static void registerCreatorVersion (unsigned int version)
 
- Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
static std::string Type ()
 
static std::shared_ptr< DtCigiPublisherBasecreate ()
 
static void registerCreator ()
 
static std::shared_ptr< DtCigiPublisherBasecreateVersion (unsigned int version)
 
static void registerCreatorVersion (unsigned int version)
 
- Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiObjectBase >
static std::string Type ()
 
static std::shared_ptr< DtCigiObjectBasecreate ()
 
static void registerCreator ()
 
static std::shared_ptr< DtCigiObjectBasecreateVersion (unsigned int version)
 
static void registerCreatorVersion (unsigned int version)
 
- Static Public Member Functions inherited from makVre::DtSpObject
template<class AS_T>
static std::shared_ptr< AS_T > cast (Sptr p)
 
template<class AS_T>
static std::shared_ptr< AS_T > unsafe_cast (Sptr p)
 
- Protected Types inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
using Wptr
 
using OwnedChildList
 
using UnownedChildList
 
using ChildNameMap
 
- Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiSimEntityComponentPublisherBase, DtCigiPublisherBase >
static std::shared_ptr< DtBaseCreator< DtCigiSimEntityComponentPublisherBase > > & creator ()
 
static std::shared_ptr< DtBaseCreator< DtCigiSimEntityComponentPublisherBase > > & creatorVersion (unsigned int version)
 
- Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > & creator ()
 
static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > & creatorVersion (unsigned int version)
 
- Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > & creator ()
 
static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > & creatorVersion (unsigned int version)
 
- Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiObjectBase >
static std::shared_ptr< DtBaseCreator< DtCigiObjectBase > > & creator ()
 
static std::shared_ptr< DtBaseCreator< DtCigiObjectBase > > & creatorVersion (unsigned int version)
 
- Protected Attributes inherited from makVre::DtCigiPublisherBase
CigiBasePtr mySharedData
 
bool myEnabled
 
bool myNeedsConfirmation
 
double myLastSentToIg
 
- Protected Attributes inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
OwnedChildList myOwnedChildren
 
UnownedChildList myUnownedChildren
 
ChildNameMap myChildrenByName
 
bool myOwnsChildren
 
Wptr myParent
 
- Protected Attributes inherited from makVre::DtCigiObjectBase
CigiBasePtr myCigiData
 
DtCigiSessionmySession
 
bool myDirty
 
- Protected Attributes inherited from makVre::DtSpObject
std::string myName
 

Constructor & Destructor Documentation

◆ DtCigiSimEntityComponentPublisherBase()

makVre::DtCigiSimEntityComponentPublisherBase::DtCigiSimEntityComponentPublisherBase ( )
inline

◆ ~DtCigiSimEntityComponentPublisherBase()

virtual makVre::DtCigiSimEntityComponentPublisherBase::~DtCigiSimEntityComponentPublisherBase ( )
inlineoverridevirtual

Member Function Documentation

◆ parentEntity()

virtual DtCigiSimEntityPublisher::Sptr makVre::DtCigiSimEntityComponentPublisherBase::parentEntity ( )
virtual

◆ simObject()

virtual DtSimObjectReference makVre::DtCigiSimEntityComponentPublisherBase::simObject ( )
virtual

◆ cigiId()

virtual Cigi_uint16 makVre::DtCigiSimEntityComponentPublisherBase::cigiId ( ) const
pure virtual

◆ sharedKey()

virtual std::string makVre::DtCigiSimEntityComponentPublisherBase::sharedKey ( )
overridevirtual

Key to uniquely idenfity the shared data instance associated with the Sim object represented by this Publisher.

No shared data will be created if sharedKey returns an empty string, which is the default behavior if not overridden by the derived Publisher class. Derived Publishers should override this function and return a suitable key if they will be using shared data.

Reimplemented from makVre::DtCigiPublisherBase.

Reimplemented in makVre::DtCigiSimEntityArtPartPublisher.

◆ initCigi()

virtual void makVre::DtCigiSimEntityComponentPublisherBase::initCigi ( )
overrideprotectedvirtual

Derived Publisher classes should override initCigi() to set initial values in the CIGI data.

Reimplemented from makVre::DtCigiPublisherBase.

Reimplemented in makVre::DtCigiSimEntityArtPartPublisher, and makVre::DtCigiSimEntityArtPartPublisherV4.

◆ setCigiId()

virtual void makVre::DtCigiSimEntityComponentPublisherBase::setCigiId ( Cigi_uint16 id)
protectedpure virtual

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