OpenSceneGraph  3.5.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::CompositeShape Class Reference
Inheritance diagram for osg::CompositeShape:
Inheritance graph
[legend]

Public Types

typedef std::vector< ref_ptr< Shape > > ChildList
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 CompositeShape ()
 
 CompositeShape (const CompositeShape &cs, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Shape (osg, CompositeShape)
 
void setShape (Shape *shape)
 Set the shape that encloses all of the children. More...
 
ShapegetShape ()
 Get the shape that encloses all of the children. More...
 
const ShapegetShape () const
 Get the const shape that encloses all of the children. More...
 
unsigned int getNumChildren () const
 Get the number of children of this composite shape. More...
 
ShapegetChild (unsigned int i)
 Get a child. More...
 
const ShapegetChild (unsigned int i) const
 Get a const child. More...
 
void addChild (Shape *shape)
 Add a child to the list. More...
 
template<class T >
void addChild (const ref_ptr< T > &child)
 
void removeChild (unsigned int i)
 remove a child from the list. More...
 
unsigned int findChildNo (Shape *shape) const
 find the index number of child, if child is not found then it returns getNumChildren(), so should be used in similar style to STL's result!=end(). More...
 
- Public Member Functions inherited from osg::Shape
 Shape ()
 
 Shape (const Shape &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 Clone the type of an attribute, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an attribute, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *obj) const
 return true if this and obj are of the same kind of object. More...
 
virtual const char * libraryName () const
 return the name of the attribute's library. More...
 
virtual const char * className () const
 return the name of the attribute's class type. More...
 
virtual void accept (ShapeVisitor &)=0
 accept a non const shape visitor which can be used on non const shape objects. More...
 
virtual void accept (ConstShapeVisitor &) const =0
 accept a const shape visitor which can be used on const shape objects. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 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. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void 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. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Member Functions

virtual ~CompositeShape ()
 
- Protected Member Functions inherited from osg::Shape
virtual ~Shape ()
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

ref_ptr< Shape_shape
 
ChildList _children
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Member Typedef Documentation

typedef std::vector< ref_ptr<Shape> > osg::CompositeShape::ChildList

Constructor & Destructor Documentation

osg::CompositeShape::CompositeShape ( )
inline
osg::CompositeShape::CompositeShape ( const CompositeShape cs,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
inline
virtual osg::CompositeShape::~CompositeShape ( )
protectedvirtual

Member Function Documentation

void osg::CompositeShape::addChild ( Shape shape)
inline

Add a child to the list.

template<class T >
void osg::CompositeShape::addChild ( const ref_ptr< T > &  child)
inline
unsigned int osg::CompositeShape::findChildNo ( Shape shape) const
inline

find the index number of child, if child is not found then it returns getNumChildren(), so should be used in similar style to STL's result!=end().

Shape* osg::CompositeShape::getChild ( unsigned int  i)
inline

Get a child.

const Shape* osg::CompositeShape::getChild ( unsigned int  i) const
inline

Get a const child.

unsigned int osg::CompositeShape::getNumChildren ( ) const
inline

Get the number of children of this composite shape.

Shape* osg::CompositeShape::getShape ( )
inline

Get the shape that encloses all of the children.

const Shape* osg::CompositeShape::getShape ( ) const
inline

Get the const shape that encloses all of the children.

osg::CompositeShape::META_Shape ( osg  ,
CompositeShape   
)
void osg::CompositeShape::removeChild ( unsigned int  i)
inline

remove a child from the list.

void osg::CompositeShape::setShape ( Shape shape)
inline

Set the shape that encloses all of the children.

Member Data Documentation

ChildList osg::CompositeShape::_children
protected
ref_ptr<Shape> osg::CompositeShape::_shape
protected

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

osg logo
Generated at Wed Nov 11 2015 22:14:30 for the OpenSceneGraph by doxygen 1.8.10.