Inheritance diagram for osg::Object:
Public Types | |
DYNAMIC | |
STATIC | |
enum | DataVariance { DYNAMIC, STATIC } |
Public Member Functions | |
Object () | |
Object (bool threadSafeRefUnref) | |
Object (const Object &, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
virtual Object * | cloneType () const =0 |
virtual Object * | clone (const CopyOp &) const =0 |
virtual bool | isSameKindAs (const Object *) const |
virtual const char * | libraryName () const =0 |
virtual const char * | className () const =0 |
void | setName (const std::string &name) |
void | setName (const char *name) |
const std::string & | getName () const |
void | setDataVariance (DataVariance dv) |
DataVariance | getDataVariance () const |
void | setUserData (Referenced *obj) |
Referenced * | getUserData () |
const Referenced * | getUserData () const |
virtual void | releaseGLObjects (osg::State *=0) const |
Protected Member Functions | |
virtual | ~Object () |
Protected Attributes | |
std::string | _name |
DataVariance | _dataVariance |
ref_ptr< Referenced > | _userData |
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 | ( | bool | threadSafeRefUnref | ) | [inline, explicit] |
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 Nodes 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().
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::AutoTransform, osg::BufferObject, osg::Drawable, osg::DrawPixels, osg::Geometry, osg::Image, osg::ImageStream, osg::RefMatrixd, osg::RefMatrixf, osg::Node, osg::PrimitiveSet, osg::DrawArrays, osg::DrawArrayLengths, osg::DrawElementsUByte, osg::DrawElementsUShort, osg::DrawElementsUInt, osg::Shape, osg::ShapeDrawable, osg::StateAttribute, osg::StateSet, osg::Texture, osgDB::Archive, osgFX::Effect, osgGA::AnimationPathManipulator, osgGA::DriveManipulator, osgGA::FlightManipulator, osgGA::CompositeGUIEventHandler, osgGA::KeySwitchMatrixManipulator, osgGA::MatrixManipulator, osgGA::NodeTrackerManipulator, osgGA::StateSetManipulator, osgGA::TerrainManipulator, osgGA::TrackballManipulator, osgGA::UFOManipulator, osgParticle::CenteredPlacer, osgParticle::Counter, osgParticle::Emitter, osgParticle::Interpolator, osgParticle::Operator, osgParticle::ParticleEffect, osgParticle::ParticleProcessor, osgParticle::Placer, osgParticle::PrecipitationEffect, osgParticle::Program, osgParticle::Shooter, osgParticle::VariableRateCounter, osgSim::ImpostorSprite, osgSim::Sector, osgText::Font, osgText::Font::GlyphTexture, osgText::Text, osgUtil::PositionalStateContainer, osgUtil::RenderBin, and osgUtil::RenderStage.
Clone an object, with Object* return type. Must be defined by derived classes.
Implemented in osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >, osg::TemplateIndexArray< T, ARRAYTYPE, DataSize, DataType >, osg::AutoTransform, osg::DrawPixels, osg::Geometry, osg::Image, osg::ImageStream, osg::RefMatrixd, osg::RefMatrixf, osg::Node, osg::DrawArrays, osg::DrawArrayLengths, osg::DrawElementsUByte, osg::DrawElementsUShort, osg::DrawElementsUInt, osg::Shape, osg::ShapeDrawable, osg::StateAttribute, osg::StateSet, osg::Texture, osgSim::ImpostorSprite, osgText::Font, osgText::Text, osgUtil::PositionalStateContainer, osgUtil::RenderBin, and osgUtil::RenderStage.
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::TemplateIndexArray< T, ARRAYTYPE, DataSize, DataType >, osg::AutoTransform, osg::DrawPixels, osg::Geometry, osg::Image, osg::ImageStream, osg::RefMatrixd, osg::RefMatrixf, osg::Node, osg::DrawArrays, osg::DrawArrayLengths, osg::DrawElementsUByte, osg::DrawElementsUShort, osg::DrawElementsUInt, osg::Shape, osg::ShapeDrawable, osg::StateAttribute, osg::StateSet, osg::Texture, osgSim::ImpostorSprite, osgText::Font, osgText::Text, osgUtil::PositionalStateContainer, osgUtil::RenderBin, and osgUtil::RenderStage.
DataVariance osg::Object::getDataVariance | ( | ) | const [inline] |
Get the data variance of this object.
const std::string& osg::Object::getName | ( | ) | const [inline] |
Get the name of 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::IndexArray, osg::AutoTransform, osg::BufferObject, osg::Drawable, osg::DrawPixels, osg::Geometry, osg::Image, osg::ImageStream, osg::RefMatrixd, osg::RefMatrixf, osg::Node, osg::PrimitiveSet, osg::DrawArrays, osg::DrawArrayLengths, osg::DrawElementsUByte, osg::DrawElementsUShort, osg::DrawElementsUInt, osg::Shape, osg::ShapeDrawable, osg::StateAttribute, osg::StateSet, osg::Texture, osgFX::Effect, osgParticle::CenteredPlacer, osgParticle::Counter, osgParticle::Emitter, osgParticle::Interpolator, osgParticle::Operator, osgParticle::ParticleEffect, osgParticle::ParticleProcessor, osgParticle::Placer, osgParticle::PrecipitationEffect, osgParticle::Program, osgParticle::Shooter, osgParticle::VariableRateCounter, osgSim::ImpostorSprite, osgSim::Sector, osgText::Font, osgText::Text, osgUtil::PositionalStateContainer, osgUtil::RenderBin, and osgUtil::RenderStage.
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 is that the namespace of a library is the same as the library name.
Implemented in osg::Array, osg::AutoTransform, osg::BufferObject, osg::Drawable, osg::DrawPixels, osg::Geometry, osg::Image, osg::ImageStream, osg::RefMatrixd, osg::RefMatrixf, osg::Node, osg::PrimitiveSet, osg::DrawArrays, osg::DrawArrayLengths, osg::DrawElementsUByte, osg::DrawElementsUShort, osg::DrawElementsUInt, osg::Shape, osg::ShapeDrawable, osg::StateAttribute, osg::StateSet, osg::Texture, osgDB::Archive, osgFX::Effect, osgParticle::CenteredPlacer, osgParticle::Counter, osgParticle::Emitter, osgParticle::Interpolator, osgParticle::Operator, osgParticle::ParticleEffect, osgParticle::ParticleProcessor, osgParticle::Placer, osgParticle::PrecipitationEffect, osgParticle::Program, osgParticle::Shooter, osgParticle::VariableRateCounter, osgSim::ImpostorSprite, osgSim::Sector, osgText::Font, osgText::Text, osgUtil::PositionalStateContainer, and osgUtil::RenderBin.
virtual void osg::Object::releaseGLObjects | ( | osg::State * | = 0 |
) | const [inline, virtual] |
If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. Otherwise, releases OpenGL objexts for all graphics contexts.
Reimplemented in osg::CameraNode, osg::Drawable, osg::FragmentProgram, osg::Geode, osg::Group, osg::Node, osg::PrimitiveSet, osg::DrawElementsUByte, osg::DrawElementsUShort, osg::DrawElementsUInt, osg::Program, osg::Shader, osg::StateAttribute, osg::StateSet, osg::Texture, osg::VertexProgram, osgText::Font, and osgText::Text.
void osg::Object::setDataVariance | ( | 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 by routines such as optimzation codes that wish to share static data.
void osg::Object::setName | ( | const char * | name | ) | [inline] |
Set the name of object using a C style string.
void osg::Object::setName | ( | const std::string & | name | ) | [inline] |
Set the name of object using C++ style string.
Reimplemented in osg::Uniform.
void osg::Object::setUserData | ( | Referenced * | obj | ) | [inline] |
Set user data, data must be subclassed from Referenced to allow automatic memory handling. If your own data isn't directly subclassed from Referenced then create an adapter object which points to your own object and handles the memory addressing.
DataVariance osg::Object::_dataVariance [protected] |
std::string osg::Object::_name [protected] |
ref_ptr<Referenced> osg::Object::_userData [protected] |