#include <Object.h>
Inherits osg::Referenced.
Inherited by osg::AnimationPath [virtual]
, osg::AudioSink, osg::AudioStream, osg::BufferData, osg::BufferData::ModifiedCallback [virtual]
, osg::BufferObject, osg::Callback [virtual]
, osg::Camera::DrawCallback [virtual]
, osg::ConvexPlanarOccluder, osg::Drawable::ComputeBoundingBoxCallback, osg::Drawable::DrawCallback [virtual]
, osg::DummyObject, osg::EllipsoidModel, osg::GraphicsContext, osg::Node, osg::Node::ComputeBoundingSphereCallback, osg::NodeVisitor [virtual]
, osg::Program::ProgramBinary, osg::RefMatrixd, osg::RefMatrixf, osg::RenderBuffer, osg::Script, osg::ScriptEngine, osg::Shader, osg::ShaderBinary, osg::ShaderComponent, osg::ShaderComposer, osg::Shape, osg::StateAttribute, osg::StateSet, osg::TessellationHints, osg::TransferFunction, osg::Uniform, osg::UserDataContainer, osg::ValueObject, osg::View [virtual]
, osgAnimation::Action, osgAnimation::Action::Callback, osgAnimation::Animation, osgAnimation::AnimationUpdateCallbackBase [virtual]
, osgAnimation::StackedTransformElement, osgAnimation::VertexInfluenceMap, osgDB::DatabaseRevision, osgDB::DatabaseRevisions, osgDB::FileList, osgDB::ImageProcessor, osgDB::MapIteratorObject, osgDB::Options, osgDB::ReaderWriter, osgGA::Device, osgGA::Event, osgGA::GUIEventAdapter::TouchData, osgManipulator::DraggerCallback [virtual]
, osgParticle::Counter, osgParticle::Interpolator, osgParticle::Operator, osgParticle::Placer, osgParticle::Shooter, osgPresentation::AnimationMaterial [virtual]
, osgPresentation::HomePosition, osgPresentation::JumpData, osgPresentation::KeyPosition, osgPresentation::PropertyManager [protected]
, osgShadow::ShadowSettings, osgShadow::ShadowTechnique, osgSim::BlinkSequence, osgSim::LightPointSystem, osgSim::ObjectRecordData, osgSim::Sector, osgSim::SequenceGroup, osgSim::ShapeAttributeList, osgTerrain::Layer, osgTerrain::Locator, osgTerrain::TerrainTechnique, osgText::Bevel, osgText::Font, osgText::Style, osgUI::AlignmentSettings, osgUI::ColorPalette, osgUI::FrameSettings, osgUI::Item, osgUI::Style, osgUI::Tab, osgUI::TextSettings, osgUI::Validator, osgUtil::PositionalStateContainer, osgUtil::RenderBin, osgUtil::SceneView, osgViewer::Keystone, osgViewer::ViewConfig, osgViewer::ViewerBase [virtual]
, osgVolume::ImageDetails, osgVolume::Layer, osgVolume::Locator, osgVolume::Locator::LocatorCallback [virtual]
, osgVolume::Property, osgVolume::VolumeTechnique, osgWidget::BrowserManager, osgWidget::Style, and osgWidget::StyleManager.
Base class/standard interface for objects which require IO support, cloning and reference counting. Based on GOF Composite, Prototype and Template Method patterns.
Definition at line 56 of file Object.h.
Enumerator |
---|
DYNAMIC |
|
STATIC |
|
UNSPECIFIED |
|
Definition at line 147 of file Object.h.
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.
Definition at line 65 of file Object.h.
osg::Object::Object |
( |
bool |
threadSafeRefUnref | ) |
|
|
inlineexplicit |
Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
virtual osg::Object::~Object |
( |
| ) |
|
|
protectedvirtual |
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 Node* osg::Object::asNode |
( |
| ) |
|
|
inlinevirtual |
Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. Equivalent to dynamic_cast<Node*>(this).
Reimplemented in osg::Node.
Definition at line 99 of file Object.h.
virtual const Node* osg::Object::asNode |
( |
| ) |
const |
|
inlinevirtual |
convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. Equivalent to dynamic_cast<const Node*>(this).
Reimplemented in osg::Node.
Definition at line 103 of file Object.h.
virtual const NodeVisitor* osg::Object::asNodeVisitor |
( |
| ) |
const |
|
inlinevirtual |
virtual Uniform* osg::Object::asUniform |
( |
| ) |
|
|
inlinevirtual |
virtual const Uniform* osg::Object::asUniform |
( |
| ) |
const |
|
inlinevirtual |
convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. Equivalent to dynamic_cast<const Uniform*>(this).
Reimplemented in osg::Uniform.
Definition at line 127 of file Object.h.
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::DrawElementsUInt, osg::RefMatrixf, osg::BufferData, osg::DrawElementsUShort, osg::GraphicsContext, osg::DrawElementsUByte, osg::RefMatrixd, osg::Texture, osg::BufferObject, osg::DrawArrayLengths, osg::DrawArrays, osgText::GlyphTexture, osgViewer::GraphicsWindowEmbedded, osg::StateAttribute, osgShadow::ShadowVolumeGeometry, osg::PrimitiveSet, osg::Image, osg::Array, osg::ShapeDrawable, osg::TemplateValueObject< T >, osg::Node, osg::BufferTemplate< std::vector< T > >, osgText::Font, osgViewer::GraphicsWindowX11, osg::Shape, osgFX::Effect, osgUtil::RenderBin, osg::Light, osgGA::UFOManipulator, osg::AudioStream, osg::ClipPlane, osgAnimation::MorphGeometry, osg::StateSet, osgSim::ImpostorSprite, osgGA::StandardManipulator, osgParticle::ParticleProcessor, osgUtil::RenderStage, osgViewer::GraphicsWindow, osgGA::CameraManipulator, osg::BufferTemplate< T >, osgShadow::OccluderGeometry, osg::Hint, osgManipulator::AntiSquish, osg::VertexAttribDivisor, osgGA::AnimationPathManipulator, osgParticle::Program, osg::DrawPixels, osgParticle::Emitter, osgParticle::Operator, osgParticle::ParticleEffect, osg::ImageSequence, osg::ImageStream, osg::UserDataContainer, osgParticle::Interpolator, osgUtil::PositionalStateContainer, osgGA::KeySwitchMatrixManipulator, osgGA::StateSetManipulator, osgSim::Sector, osgViewer::GraphicsWindowWin32, osgViewer::PixelBufferWin32, osg::AutoTransform, osgParticle::Placer, osgText::Text, osg::ShaderAttribute, osgDB::Archive, osgParticle::PrecipitationEffect, osgParticle::Shooter, osgText::TextBase, osgViewer::PixelBufferX11, osgGA::DriveManipulator, osgParticle::CenteredPlacer, osgParticle::VariableRateCounter, osg::AudioSink, osgParticle::Counter, osgGA::SphericalManipulator, and osgGA::CameraViewSwitchManipulator.
Clone an object, with Object* return type. Must be defined by derived classes.
Implemented in osg::DrawElementsUInt, osg::RefMatrixf, osg::DrawElementsUShort, osg::GraphicsContext, osg::DrawElementsUByte, osg::RefMatrixd, osg::Texture, osg::TemplateIndexArray< T, ARRAYTYPE, DataSize, DataType >, osg::DrawArrayLengths, osg::DrawArrays, osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >, osg::StateAttribute, osgShadow::ShadowVolumeGeometry, osg::Image, osg::ShapeDrawable, osg::TemplateValueObject< T >, osg::Node, osg::BufferTemplate< std::vector< T > >, osgText::Font, osgUtil::RenderBin, osg::Light, osg::Shape, osg::ClipPlane, osgAnimation::MorphGeometry, osg::StateSet, osgSim::ImpostorSprite, osg::BufferTemplate< T >, osgUtil::RenderStage, osgShadow::OccluderGeometry, osg::Hint, osg::VertexAttribDivisor, osgManipulator::AntiSquish, osg::ImageSequence, osg::ImageStream, osg::DrawPixels, osgUtil::PositionalStateContainer, osg::AutoTransform, osgText::Text, and osg::ShaderAttribute.
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::DrawElementsUInt, osg::RefMatrixf, osg::DrawElementsUShort, osg::GraphicsContext, osg::DrawElementsUByte, osg::RefMatrixd, osg::Texture, osg::TemplateIndexArray< T, ARRAYTYPE, DataSize, DataType >, osg::DrawArrayLengths, osg::DrawArrays, osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >, osg::StateAttribute, osgShadow::ShadowVolumeGeometry, osg::Image, osg::ShapeDrawable, osg::TemplateValueObject< T >, osg::BufferTemplate< std::vector< T > >, osg::Node, osgText::Font, osgUtil::RenderBin, osg::Light, osg::Shape, osg::ClipPlane, osgAnimation::MorphGeometry, osg::StateSet, osg::BufferTemplate< T >, osgUtil::RenderStage, osgSim::ImpostorSprite, osgShadow::OccluderGeometry, osg::Hint, osg::VertexAttribDivisor, osg::ImageSequence, osg::ImageStream, osgManipulator::AntiSquish, osgUtil::PositionalStateContainer, osg::AutoTransform, osg::DrawPixels, osgText::Text, and osg::ShaderAttribute.
virtual void osg::Object::computeDataVariance |
( |
| ) |
|
|
inlinevirtual |
std::string osg::Object::getCompoundClassName |
( |
| ) |
const |
|
inline |
return the compound class name that combines the library name and class name.
Definition at line 94 of file Object.h.
Get the data variance of this object.
Definition at line 162 of file Object.h.
const std::string& osg::Object::getName |
( |
| ) |
const |
|
inline |
Get the name of object.
Definition at line 144 of file Object.h.
virtual const Referenced* osg::Object::getUserData |
( |
| ) |
const |
|
virtual |
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool osg::Object::getUserValue |
( |
const std::string & |
name, |
|
|
T & |
value |
|
) |
| const |
template<typename T >
bool osg::Object::getUserValue |
( |
const std::string & |
name, |
|
|
T & |
value |
|
) |
| const |
Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. To use this template method you need to include the osg/ValueObject header.
virtual bool osg::Object::isSameKindAs |
( |
const Object * |
| ) |
const |
|
inlinevirtual |
Reimplemented in osg::DrawElementsUInt, osg::RefMatrixf, osg::BufferData, osg::DrawElementsUShort, osg::GraphicsContext, osg::DrawElementsUByte, osg::RefMatrixd, osg::Texture, osg::BufferObject, osg::DrawArrayLengths, osg::IndexArray, osg::DrawArrays, osg::StateAttribute, osgShadow::ShadowVolumeGeometry, osg::PrimitiveSet, osg::Image, osg::Array, osg::ShapeDrawable, osg::TemplateValueObject< T >, osg::Node, osg::BufferTemplate< std::vector< T > >, osgText::Font, osgFX::Effect, osgUtil::RenderBin, osg::Shape, osg::Light, osg::AudioStream, osg::ClipPlane, osgAnimation::MorphGeometry, osg::StateSet, osgParticle::ParticleProcessor, osgSim::ImpostorSprite, osgUtil::RenderStage, osg::BufferTemplate< T >, osgParticle::Program, osgShadow::OccluderGeometry, osg::Hint, osgParticle::Emitter, osgParticle::Operator, osgParticle::ParticleEffect, osg::VertexAttribDivisor, osgManipulator::AntiSquish, osgParticle::Interpolator, osgSim::Sector, osg::DrawPixels, osg::ImageSequence, osg::ImageStream, osgParticle::Placer, osgParticle::PrecipitationEffect, osgParticle::Shooter, osgUtil::PositionalStateContainer, osg::AutoTransform, osgParticle::CenteredPlacer, osgText::Text, osgText::TextBase, osg::ShaderAttribute, osgParticle::VariableRateCounter, osg::UserDataContainer, and osgParticle::Counter.
Definition at line 81 of file Object.h.
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::DrawElementsUInt, osg::RefMatrixf, osg::BufferData, osg::DrawElementsUShort, osg::GraphicsContext, osg::DrawElementsUByte, osg::RefMatrixd, osg::Texture, osg::BufferObject, osg::DrawArrayLengths, osg::DrawArrays, osgViewer::GraphicsWindowEmbedded, osg::StateAttribute, osgShadow::ShadowVolumeGeometry, osg::PrimitiveSet, osg::Image, osg::Array, osg::ShapeDrawable, osg::TemplateValueObject< T >, osg::Node, osg::BufferTemplate< std::vector< T > >, osgText::Font, osgViewer::GraphicsWindowX11, osgFX::Effect, osgUtil::RenderBin, osg::Shape, osg::Light, osg::AudioStream, osg::ClipPlane, osgAnimation::MorphGeometry, osg::StateSet, osgSim::ImpostorSprite, osgParticle::ParticleProcessor, osgViewer::GraphicsWindow, osg::BufferTemplate< T >, osgShadow::OccluderGeometry, osg::Hint, osgManipulator::AntiSquish, osg::VertexAttribDivisor, osgParticle::Program, osg::DrawPixels, osgParticle::Emitter, osgParticle::Operator, osgParticle::ParticleEffect, osg::ImageSequence, osg::ImageStream, osg::AutoTransform, osgParticle::Interpolator, osgText::Text, osgUtil::PositionalStateContainer, osgSim::Sector, osgText::TextBase, osgViewer::GraphicsWindowWin32, osgViewer::PixelBufferWin32, osg::UserDataContainer, osgParticle::Placer, osg::ShaderAttribute, osgParticle::PrecipitationEffect, osgParticle::Shooter, osgViewer::PixelBufferX11, osgDB::Archive, osgParticle::CenteredPlacer, osgParticle::VariableRateCounter, osg::AudioSink, and osgParticle::Counter.
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::Texture, osg::Camera, osg::BufferData, osg::StateSet, osg::Node, osg::BufferObject, osg::FrameBufferObject, osg::StateAttribute, osg::ShaderComponent, osgText::Text, osg::Drawable, osgText::TextBase, osgUtil::RenderStage, osg::VertexProgram, osg::FragmentProgram, osgTerrain::TerrainTile, osg::Shader, osgTerrain::HeightFieldDrawable, osg::RenderBuffer, osgText::Font, osgUtil::RenderBin, osg::Geometry, osgUI::Widget, osg::Group, osgSim::OverlayNode, osgText::Text3D, osg::OcclusionQueryNode, osgTerrain::TerrainTechnique, osg::Program, osg::QueryGeometry, osgDB::SharedStateManager, osgTerrain::SharedGeometry, osgTerrain::GeometryTechnique, osg::ShaderAttribute, osgShadow::ShadowedScene, osgShadow::ViewDependentShadowMap, and osgTerrain::DisplacementMappingTechnique.
Definition at line 216 of file Object.h.
virtual void osg::Object::resizeGLObjectBuffers |
( |
unsigned int |
| ) |
|
|
inlinevirtual |
Resize any per context GLObject buffers to specified size.
Reimplemented in osg::Texture, osg::PixelDataBufferObject, osg::Camera, osg::BufferData, osg::StateSet, osg::Node, osg::BufferObject, osg::FrameBufferObject, osg::StateAttribute, osg::ShaderComponent, osgText::Text, osgText::GlyphTexture, osg::Drawable, osgText::TextBase, osg::VertexProgram, osg::FragmentProgram, osgTerrain::HeightFieldDrawable, osg::Shader, osg::RenderBuffer, osgText::Font, osgUI::Widget, osg::Geometry, osg::Group, osgSim::OverlayNode, osgText::Text3D, osg::Program, osgTerrain::SharedGeometry, osg::ShaderAttribute, osgShadow::ShadowedScene, and osgShadow::ViewDependentShadowMap.
Definition at line 211 of file Object.h.
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.
Definition at line 159 of file Object.h.
virtual void osg::Object::setName |
( |
const std::string & |
name | ) |
|
|
inlinevirtual |
Set the name of object using C++ style string.
Reimplemented in osg::Uniform.
Definition at line 134 of file Object.h.
void osg::Object::setName |
( |
const char * |
name | ) |
|
|
inline |
Set the name of object using a C style string.
Definition at line 137 of file Object.h.
virtual void osg::Object::setThreadSafeRefUnref |
( |
bool |
threadSafe | ) |
|
|
virtual |
Set whether to use a mutex to ensure ref() and unref() are thread safe.
Reimplemented from osg::Referenced.
Reimplemented in osg::StateSet, osg::Node, osgText::Text, osgText::GlyphTexture, osg::Drawable, osgText::TextBase, osgText::Font, osg::Group, osgSim::OverlayNode, osgText::Text3D, osg::LightSource, osg::Program, and osg::TexGenNode.
template<typename T >
void osg::Object::setUserValue |
( |
const std::string & |
name, |
|
|
const T & |
value |
|
) |
| |
Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. To use this template method you need to include the osg/ValueObject header.
provide implementation of osg::Object::setUserValue(..) template.
Definition at line 209 of file ValueObject.h.
std::string osg::Object::_name |
|
protected |
The documentation for this class was generated from the following files: