OpenSceneGraph 2.8.3

osg::Object Class Reference

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

Inherits osg::Referenced.

Inherited by osg::AnimationPath [virtual], osg::Array, osg::AudioSink, osg::AudioStream, osg::BufferObject, osg::Camera::DrawCallback [virtual], osg::ConvexPlanarOccluder, osg::Drawable, osg::Drawable::ComputeBoundingBoxCallback, osg::Drawable::CullCallback [virtual], osg::Drawable::DrawCallback [virtual], osg::Drawable::EventCallback [virtual], osg::Drawable::UpdateCallback [virtual], osg::EllipsoidModel, osg::GraphicsContext, osg::Image, osg::Node, osg::Node::ComputeBoundingSphereCallback, osg::NodeCallback [virtual], osg::PrimitiveSet, osg::RefMatrixd, osg::RefMatrixf, osg::RenderBuffer, osg::Shader, osg::Shape, osg::StateAttribute, osg::StateAttributeCallback [virtual], osg::StateSet, osg::StateSet::Callback [virtual], osg::TessellationHints, osg::TransferFunction, osg::Uniform, osg::Uniform::Callback [virtual], osg::View [virtual], osgAnimation::Action, osgAnimation::Action::Callback, osgAnimation::Animation, osgAnimation::AnimationUpdateCallbackBase [virtual], osgAnimation::StackedTransformElement, osgAnimation::VertexInfluenceMap, osgDB::ReaderWriter, osgDB::ReaderWriter::Options, osgGA::GUIEventAdapter, osgParticle::Counter, osgParticle::Interpolator, osgParticle::Operator, osgParticle::Placer, osgParticle::Shooter, osgShadow::ShadowTechnique, osgSim::BlinkSequence, osgSim::LightPointSystem, osgSim::ObjectRecordData, osgSim::Sector, osgSim::SequenceGroup, osgSim::ShapeAttributeList, osgTerrain::Layer, osgTerrain::Locator, osgTerrain::TerrainTechnique, osgText::Font, osgText::Font3D, osgUtil::PositionalStateContainer, osgUtil::RenderBin, osgUtil::SceneView, osgViewer::CompositeViewer [virtual], osgViewer::ViewerBase [virtual], osgVolume::Layer, osgVolume::Locator, osgVolume::Property, osgVolume::VolumeTechnique, osgWidget::BrowserManager, osgWidget::Style, and osgWidget::StyleManager.

List of all members.

Public Types

enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions

 Object ()
 Construct an object.
 Object (bool threadSafeRefUnref)
 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 ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone 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 setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
ReferencedgetUserData ()
 Get user data.
const ReferencedgetUserData () const
 Get const user data.
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.

Protected Member Functions

virtual ~Object ()
 Object destructor.

Protected Attributes

std::string _name
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

Enumerator:
DYNAMIC 
STATIC 
UNSPECIFIED 

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 ( bool  threadSafeRefUnref) [inline, explicit]
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 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().


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::AudioSink, osg::AudioStream, osg::AutoTransform, osg::BufferObject, osg::ClipPlane, osg::Drawable, osg::DrawPixels, osg::Geometry, osg::GraphicsContext, osg::Hint, osg::Image, osg::ImageSequence, osg::ImageStream, osg::Light, 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::CameraViewSwitchManipulator, osgGA::DriveManipulator, osgGA::FlightManipulator, 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, osgShadow::OccluderGeometry, osgShadow::ShadowVolumeGeometry, osgSim::ImpostorSprite, osgSim::Sector, osgText::Font, osgText::Font::GlyphTexture, osgText::Font3D, osgText::Text, osgText::TextBase, osgUtil::PositionalStateContainer, osgUtil::RenderBin, osgUtil::RenderStage, osgViewer::GraphicsWindowWin32, osgViewer::PixelBufferWin32, osgViewer::GraphicsWindowX11, osgViewer::PixelBufferX11, osgViewer::GraphicsWindow, osgViewer::GraphicsWindowEmbedded, and osgAnimation::MorphGeometry.

virtual void osg::Object::computeDataVariance ( ) [inline, virtual]

Compute the DataVariance based on an assessment of callback etc.

Reimplemented in osg::Drawable, and osg::StateSet.

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

Get the data variance of this object.

Referenced by osgUtil::RenderLeaf::RenderLeaf(), and osgUtil::StateGraph::StateGraph().

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

Get const user data.

virtual const char* osg::Object::libraryName ( ) const [pure virtual]
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 objects for all graphics contexts.

Reimplemented in osg::BufferObject, osg::Camera, osg::Drawable, osg::FragmentProgram, osg::Geode, osg::Geometry, osg::Group, osg::Node, osg::OcclusionQueryNode, osg::PrimitiveSet, osg::DrawElements, osg::Program, osg::Shader, osg::StateAttribute, osg::StateSet, osg::Texture, osg::VertexProgram, osgSim::OverlayNode, osgText::Font, osgText::Text, osgText::Text3D, and osgText::TextBase.

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 optimization codes that wish to share static data. UNSPECIFIED is used to specify that the DataVariance hasn't been set yet.

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.

Referenced by osgAnimation::AnimationUpdateCallback< osg::StateAttributeCallback >::AnimationUpdateCallback().

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.


Member Data Documentation


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

osg logo
Generated at Tue Mar 22 2011 13:20:22 for the OpenSceneGraph by doxygen 1.7.3.