class SG_EXPORT osg::Object: public Referenced

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

Inheritance:

Public Methods

Object()

Construct an object.

virtual Object* clone() const

return a shallow copy of a node, with Object* return type.

virtual bool isSameKindAs(Object*)

virtual const char* className() const

return the name of the object's class type.

virtual Object* readClone(Input& fr)

Template Method/Prototype Pattern : create a clone and read Object data from Input.

virtual bool write(Output& fw)

Template Method Pattern : write out Object data to Output.

Protected Methods

virtual ~Object()

Object destructor.

virtual bool readLocalData(Input&)

Template Method Pattern : read local data from osg file.

virtual bool writeLocalData(Output&)

Template Method Pattern : write local data to osg file.

Inherited from Referenced:

Public Methods

Referenced& operator = (Referenced&)

void ref()

void unref()

int referenceCount()

Protected Fields

int _refCount

Object()

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

virtual Object* clone() const

return a shallow copy of a node, with Object* return type. Must be defined by derived classes.

virtual bool isSameKindAs(Object*)

virtual const char* className() const

return the name of the object's class type. Must be defined by derived classes.

virtual Object* readClone(Input& fr)

Template Method/Prototype Pattern : create a clone and read Object data from Input. Reads Input and if it matches this objects className() then create a clone and match '{' brackets and repeating calling Object::readLocalData() until the matching ']' is read.

virtual bool write(Output& fw)

Template Method Pattern : write out Object data to Output. Sequence of output is className() followed by Open '{' and then call Object::writeLocalData() and complete with '}'.

virtual ~Object()

Object destructor. Note, is protected so that Objects cannot be deleted other than by being derefernced 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().

virtual bool readLocalData(Input&)

Template Method Pattern : read local data from osg file. Note should be implemented in derivied classes, which call their parent class's readLocalData. Returns true if the input iterator has been advanced, otherwise false.

virtual bool writeLocalData(Output&)

Template Method Pattern : write local data to osg file. Note should be implemented in derivied classes, which call their parent class's writeLocalData. Returns true if data has been written out, otherwise false.

Direct child classes:

Transparency
Texture
TexGen
TexEnv
PolygonOffset
Point
Node
Matrix
Material
Light
Image
GeoState
GeoSet
Fog
CullFace
AlphaFunc

Alphabetic index HTML hierarchy of classes or Java