OpenSceneGraph
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
osgDB::ObjectWrapper Class Reference
Inheritance diagram for osgDB::ObjectWrapper:
Inheritance graph
[legend]

Public Types

typedef std::vector< BaseSerializer::TypeTypeList
 
typedef std::vector< osg::ref_ptr< BaseSerializer > > SerializerList
 
typedef std::vector< osg::ref_ptr< FinishedObjectReadCallback > > FinishedObjectReadCallbackList
 
typedef std::list< ObjectWrapperAssociateRevisionAssociateList
 
typedef osg::ObjectCreateInstanceFunc()
 
typedef std::multimap< std::string, osg::ref_ptr< MethodObject > > MethodObjectMap
 

Public Member Functions

 ObjectWrapper (CreateInstanceFunc *createInstanceFunc, const std::string &name, const std::string &associates)
 
 ObjectWrapper (CreateInstanceFunc *createInstanceFunc, const std::string &domain, const std::string &name, const std::string &associates)
 
void setUpdatedVersion (int ver)
 
int getUpdatedVersion () const
 
osg::ObjectcreateInstance () const
 
const std::string & getDomain () const
 
const std::string & getName () const
 
const RevisionAssociateListgetAssociates () const
 
SerializerListgetSerializerList ()
 
const SerializerListgetSerializerList () const
 
TypeListgetTypeList ()
 
const TypeListgetTypeList () const
 
void addSerializer (BaseSerializer *s, BaseSerializer::Type t=BaseSerializer::RW_UNDEFINED)
 
void markSerializerAsRemoved (const std::string &name)
 
void markAssociateAsRemoved (const std::string &name)
 
void markAssociateAsAdded (const std::string &name)
 
BaseSerializergetLastSerializer ()
 
BaseSerializergetSerializer (const std::string &name)
 
BaseSerializergetSerializer (const std::string &name, BaseSerializer::Type &type)
 
void addFinishedObjectReadCallback (FinishedObjectReadCallback *forc)
 
bool read (InputStream &, osg::Object &)
 
bool write (OutputStream &, const osg::Object &)
 
bool readSchema (const StringList &properties, const TypeList &types)
 
void writeSchema (StringList &properties, TypeList &types)
 
void resetSchema ()
 
void addMethodObject (const std::string &methodName, MethodObject *mo)
 
MethodObjectMapgetMethodObjectMap ()
 
const MethodObjectMapgetMethodObjectMap () const
 
void setupAssociatesRevisionsInheritanceIfRequired ()
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool)
 Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called. More...
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Member Functions

 ObjectWrapper ()
 
virtual ~ObjectWrapper ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Static Protected Member Functions

static void splitAssociates (const std::string &src, ObjectWrapper::RevisionAssociateList &list, char separator=' ')
 

Protected Attributes

CreateInstanceFunc_createInstanceFunc
 
std::string _domain
 
std::string _name
 
RevisionAssociateList _associates
 
SerializerList _serializers
 
SerializerList _backupSerializers
 
TypeList _typeList
 
FinishedObjectReadCallbackList _finishedObjectReadCallbacks
 
MethodObjectMap _methodObjectMap
 
int _version
 
bool _isAssociatesRevisionsInheritanceDone
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Member Typedef Documentation

◆ CreateInstanceFunc

typedef osg::Object* osgDB::ObjectWrapper::CreateInstanceFunc()

◆ FinishedObjectReadCallbackList

◆ MethodObjectMap

typedef std::multimap< std::string, osg::ref_ptr<MethodObject> > osgDB::ObjectWrapper::MethodObjectMap

◆ RevisionAssociateList

◆ SerializerList

◆ TypeList

Constructor & Destructor Documentation

◆ ObjectWrapper() [1/3]

osgDB::ObjectWrapper::ObjectWrapper ( CreateInstanceFunc createInstanceFunc,
const std::string &  name,
const std::string &  associates 
)

◆ ObjectWrapper() [2/3]

osgDB::ObjectWrapper::ObjectWrapper ( CreateInstanceFunc createInstanceFunc,
const std::string &  domain,
const std::string &  name,
const std::string &  associates 
)

◆ ObjectWrapper() [3/3]

osgDB::ObjectWrapper::ObjectWrapper ( )
inlineprotected

◆ ~ObjectWrapper()

virtual osgDB::ObjectWrapper::~ObjectWrapper ( )
inlineprotectedvirtual

Member Function Documentation

◆ addFinishedObjectReadCallback()

void osgDB::ObjectWrapper::addFinishedObjectReadCallback ( FinishedObjectReadCallback forc)
inline

◆ addMethodObject()

void osgDB::ObjectWrapper::addMethodObject ( const std::string &  methodName,
MethodObject mo 
)

◆ addSerializer()

void osgDB::ObjectWrapper::addSerializer ( BaseSerializer s,
BaseSerializer::Type  t = BaseSerializer::RW_UNDEFINED 
)

◆ createInstance()

osg::Object* osgDB::ObjectWrapper::createInstance ( ) const
inline

◆ getAssociates()

const RevisionAssociateList& osgDB::ObjectWrapper::getAssociates ( ) const
inline

◆ getDomain()

const std::string& osgDB::ObjectWrapper::getDomain ( ) const
inline

◆ getLastSerializer()

BaseSerializer* osgDB::ObjectWrapper::getLastSerializer ( )
inline

◆ getMethodObjectMap() [1/2]

MethodObjectMap& osgDB::ObjectWrapper::getMethodObjectMap ( )
inline

◆ getMethodObjectMap() [2/2]

const MethodObjectMap& osgDB::ObjectWrapper::getMethodObjectMap ( ) const
inline

◆ getName()

const std::string& osgDB::ObjectWrapper::getName ( ) const
inline

◆ getSerializer() [1/2]

BaseSerializer* osgDB::ObjectWrapper::getSerializer ( const std::string &  name)

◆ getSerializer() [2/2]

BaseSerializer* osgDB::ObjectWrapper::getSerializer ( const std::string &  name,
BaseSerializer::Type type 
)

◆ getSerializerList() [1/2]

SerializerList& osgDB::ObjectWrapper::getSerializerList ( )
inline

◆ getSerializerList() [2/2]

const SerializerList& osgDB::ObjectWrapper::getSerializerList ( ) const
inline

◆ getTypeList() [1/2]

TypeList& osgDB::ObjectWrapper::getTypeList ( )
inline

◆ getTypeList() [2/2]

const TypeList& osgDB::ObjectWrapper::getTypeList ( ) const
inline

◆ getUpdatedVersion()

int osgDB::ObjectWrapper::getUpdatedVersion ( ) const
inline

◆ markAssociateAsAdded()

void osgDB::ObjectWrapper::markAssociateAsAdded ( const std::string &  name)

◆ markAssociateAsRemoved()

void osgDB::ObjectWrapper::markAssociateAsRemoved ( const std::string &  name)

◆ markSerializerAsRemoved()

void osgDB::ObjectWrapper::markSerializerAsRemoved ( const std::string &  name)

◆ read()

bool osgDB::ObjectWrapper::read ( InputStream ,
osg::Object  
)

◆ readSchema()

bool osgDB::ObjectWrapper::readSchema ( const StringList properties,
const TypeList types 
)

◆ resetSchema()

void osgDB::ObjectWrapper::resetSchema ( )
inline

◆ setupAssociatesRevisionsInheritanceIfRequired()

void osgDB::ObjectWrapper::setupAssociatesRevisionsInheritanceIfRequired ( )

◆ setUpdatedVersion()

void osgDB::ObjectWrapper::setUpdatedVersion ( int  ver)
inline

◆ splitAssociates()

static void osgDB::ObjectWrapper::splitAssociates ( const std::string &  src,
ObjectWrapper::RevisionAssociateList list,
char  separator = ' ' 
)
staticprotected

◆ write()

bool osgDB::ObjectWrapper::write ( OutputStream ,
const osg::Object  
)

◆ writeSchema()

void osgDB::ObjectWrapper::writeSchema ( StringList properties,
TypeList types 
)

Member Data Documentation

◆ _associates

RevisionAssociateList osgDB::ObjectWrapper::_associates
protected

◆ _backupSerializers

SerializerList osgDB::ObjectWrapper::_backupSerializers
protected

◆ _createInstanceFunc

CreateInstanceFunc* osgDB::ObjectWrapper::_createInstanceFunc
protected

◆ _domain

std::string osgDB::ObjectWrapper::_domain
protected

◆ _finishedObjectReadCallbacks

FinishedObjectReadCallbackList osgDB::ObjectWrapper::_finishedObjectReadCallbacks
protected

◆ _isAssociatesRevisionsInheritanceDone

bool osgDB::ObjectWrapper::_isAssociatesRevisionsInheritanceDone
protected

◆ _methodObjectMap

MethodObjectMap osgDB::ObjectWrapper::_methodObjectMap
protected

◆ _name

std::string osgDB::ObjectWrapper::_name
protected

◆ _serializers

SerializerList osgDB::ObjectWrapper::_serializers
protected

◆ _typeList

TypeList osgDB::ObjectWrapper::_typeList
protected

◆ _version

int osgDB::ObjectWrapper::_version
protected

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