Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

osg::Object Class Reference

Base class/standard interface for objects which require IO support, cloning and reference counting. More...

Inheritance diagram for osg::Object:

Inheritance graph
[legend]
List of all members.

Public Types

enum  DataVariance { DYNAMIC, STATIC }

Public Methods

 Object ()
 Construct an object.

 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.

virtual Object * cloneType () const=0
 Clone the type of an object, with Object* return type.

virtual Object * clone (const CopyOp &) const=0
 Clone the an object, with Object* return type.

virtual bool isSameKindAs (const Object *) const
virtual const char * libraryName () const=0
 return the name of the object's library.

virtual const char * className () const=0
 return the name of the object's class type.

void setDataVariance (const DataVariance dv)
 Set the data variance of this object.

const DataVariance getDataVariance () const
 Get the data variance of this object.

void setUserData (Referenced *obj)
 Set user data, data must be subclased from Referenced to allow automatic memory handling.

ReferencedgetUserData ()
 Get user data.

const ReferencedgetUserData () const
 Get const user data.


Protected Methods

virtual ~Object ()
 Object destructor.


Protected Attributes

DataVariance _dataVariance
ref_ptr< Referenced_userData

Detailed Description

Base class/standard interface for objects which require IO support, cloning and reference counting.

Based on GOF Composite, Prototype and Template Method patterns.


Member Enumeration Documentation

enum osg::Object::DataVariance
 

Enumeration values:
DYNAMIC 
STATIC 


Constructor & Destructor Documentation

osg::Object::Object   [inline]
 

Construct an object.

Note Object is a pure virtual base class and therefore cannot be constructed on its own, only derived classes which override the clone and className methods are concrete classes and can be constructed.

osg::Object::Object const Object &   ,
const CopyOp   copyop = CopyOp::SHALLOW_COPY
 

Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.

virtual osg::Object::~Object   [inline, protected, virtual]
 

Object destructor.

Note, is protected so that Objects cannot be deleted other than by being dereferenced and the reference count being zero (see osg::Referenced), preventing the deletion of nodes which are still in use. This also means that Node's cannot be created on stack i.e Node node will not compile, forcing all nodes to be created on the heap i.e Node* node = new Node().


Member Function Documentation

virtual const char* osg::Object::className   const [pure virtual]
 

return the name of the object's class type.

Must be defined by derived classes.

Implemented in osg::Array, osg::Drawable, osg::DrawPixels, osg::Geometry, osg::GeoSet, osg::Image, osg::ImpostorSprite, osg::Matrix, osg::Node, osg::Primitive, osg::DrawArrays, osg::DrawArrayLengths, osg::DrawElementsUByte, osg::DrawElementsUShort, osg::DrawElementsUInt, osg::StateAttribute, osg::StateSet, osg::Texture, osgParticle::CenteredPlacer, osgParticle::Counter, osgParticle::Emitter, osgParticle::Interpolator, osgParticle::Operator, osgParticle::ParticleProcessor, osgParticle::Placer, osgParticle::Program, osgParticle::Shooter, osgParticle::VariableRateCounter, osgText::Font, osgText::RasterFont, osgText::VectorFont, osgText::Text, osgUtil::DepthSortedBin, osgUtil::RenderBin, osgUtil::RenderStage, osgUtil::RenderStageLighting, and osgUtil::RenderToTextureStage.

virtual Object* osg::Object::clone const CopyOp   const [pure virtual]
 

Clone the an object, with Object* return type.

Must be defined by derived classes.

Implemented in osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >, osg::DrawPixels, osg::Geometry, osg::GeoSet, osg::Image, osg::ImpostorSprite, osg::Matrix, osg::Node, osg::DrawArrays, osg::DrawArrayLengths, osg::DrawElementsUByte, osg::DrawElementsUShort, osg::DrawElementsUInt, osg::StateAttribute, osg::StateSet, osg::Texture, osg::TemplateArray< float, Array::FloatArrayType, 1, GL_FLOAT >, and osg::TemplateArray< Vec3, Array::Vec3ArrayType, 3, GL_FLOAT >.

virtual Object* osg::Object::cloneType   const [pure virtual]
 

Clone the type of an object, with Object* return type.

Must be defined by derived classes.

Implemented in osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >, osg::DrawPixels, osg::Geometry, osg::GeoSet, osg::Image, osg::ImpostorSprite, osg::Matrix, osg::Node, osg::DrawArrays, osg::DrawArrayLengths, osg::DrawElementsUByte, osg::DrawElementsUShort, osg::DrawElementsUInt, osg::StateAttribute, osg::StateSet, osg::Texture, osgText::Text, osgUtil::DepthSortedBin, osgUtil::RenderBin, osgUtil::RenderStage, osgUtil::RenderStageLighting, osgUtil::RenderToTextureStage, osg::TemplateArray< float, Array::FloatArrayType, 1, GL_FLOAT >, and osg::TemplateArray< Vec3, Array::Vec3ArrayType, 3, GL_FLOAT >.

const DataVariance osg::Object::getDataVariance   const [inline]
 

Get the data variance of this object.

const Referenced* osg::Object::getUserData   const [inline]
 

Get const user data.

Referenced* osg::Object::getUserData   [inline]
 

Get user data.

virtual bool osg::Object::isSameKindAs const Object *    const [inline, virtual]
 

Reimplemented in osg::Array, osg::Drawable, osg::DrawPixels, osg::Geometry, osg::GeoSet, osg::Image, osg::ImpostorSprite, osg::Matrix, osg::Node, osg::Primitive, osg::DrawArrays, osg::DrawArrayLengths, osg::DrawElementsUByte, osg::DrawElementsUShort, osg::DrawElementsUInt, osg::StateAttribute, and osg::StateSet.

virtual const char* osg::Object::libraryName   const [pure virtual]
 

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention the is that the namspace of a library is the same as the library name.

Implemented in osg::Array, osg::Drawable, osg::DrawPixels, osg::Geometry, osg::GeoSet, osg::Image, osg::ImpostorSprite, osg::Matrix, osg::Node, osg::Primitive, osg::DrawArrays, osg::DrawArrayLengths, osg::DrawElementsUByte, osg::DrawElementsUShort, osg::DrawElementsUInt, osg::StateAttribute, osg::StateSet, osg::Texture, osgParticle::CenteredPlacer, osgParticle::Counter, osgParticle::Emitter, osgParticle::Interpolator, osgParticle::Operator, osgParticle::Placer, osgParticle::Program, osgParticle::Shooter, osgText::Font, osgText::RasterFont, osgText::VectorFont, osgText::Text, osgUtil::DepthSortedBin, osgUtil::RenderBin, osgUtil::RenderStageLighting, and osgUtil::RenderToTextureStage.

void osg::Object::setDataVariance const DataVariance    dv [inline]
 

Set the data variance of this object.

Can be set to either STATIC for values that do not change over the lifetime of the object, or DYNAMIC for values that vary over the lifetime of the object. The DataVariance value can be used be routines such as optimzation codes that wish to share static data.

void osg::Object::setUserData Referenced   obj [inline]
 

Set user data, data must be subclased from Referenced to allow automatic memory handling.

If you own data isn't directly subclassed from Referenced then create and adapter object which points to your own objects and handles the memory addressing.


Member Data Documentation

DataVariance osg::Object::_dataVariance [protected]
 

ref_ptr<Referenced> osg::Object::_userData [protected]
 


The documentation for this class was generated from the following file:
Generated at Wed Sep 18 13:55:36 2002 for the Open Scene Graph by doxygen 1.2.16.