OpenSceneGraph  3.0.1
Public Member Functions | Protected Member Functions
osgParticle::SegmentPlacer Class Reference

A segment-shaped particle placer. More...

Inheritance diagram for osgParticle::SegmentPlacer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 SegmentPlacer ()
 SegmentPlacer (const SegmentPlacer &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Object (osgParticle, SegmentPlacer)
const osg::Vec3getVertexA () const
 get vertex A.
void setVertexA (const osg::Vec3 &v)
 Set vertex A of the segment as a vector.
void setVertexA (float x, float y, float z)
 Set vertex A of the segment as three floats.
const osg::Vec3getVertexB () const
 get vertex B.
void setVertexB (const osg::Vec3 &v)
 Set vertex B of the segment as a vector.
void setVertexB (float x, float y, float z)
 Set vertex B of the segment as three floats.
void setSegment (const osg::Vec3 &A, const osg::Vec3 &B)
 Set both vertices.
void place (Particle *P) const
 Place a particle. This method is called by ModularEmitter, do not call it manually.
float volume () const
 return the length of the segment
osg::Vec3 getControlPosition () const
 return the control position
- Public Member Functions inherited from osgParticle::Placer
 Placer ()
 Placer (const Placer &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual const char * libraryName () const
 return the name of the object's library.
virtual const char * className () const
 return the name of the object's class type.
virtual bool isSameKindAs (const osg::Object *obj) const
- Public Member Functions inherited from osg::Object
 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 void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual 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 setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience 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.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
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.
- 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.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Protected Member Functions

virtual ~SegmentPlacer ()
SegmentPlaceroperator= (const SegmentPlacer &)
- Protected Member Functions inherited from osgParticle::Placer
 ~Placer ()
Placeroperator= (const Placer &)
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor.
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Detailed Description

A segment-shaped particle placer.

To use this placer you have to define a segment, by setting its two vertices (A and B); when an emitter requests a SegmentPlacer to place a particle, the position is chosen randomly within that segment.


Constructor & Destructor Documentation

osgParticle::SegmentPlacer::SegmentPlacer ( )
inline
osgParticle::SegmentPlacer::SegmentPlacer ( const SegmentPlacer copy,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
inline
virtual osgParticle::SegmentPlacer::~SegmentPlacer ( )
inlineprotectedvirtual

Member Function Documentation

osg::Vec3 osgParticle::SegmentPlacer::getControlPosition ( ) const
inlinevirtual

return the control position

Implements osgParticle::Placer.

const osg::Vec3 & osgParticle::SegmentPlacer::getVertexA ( ) const
inline

get vertex A.

const osg::Vec3 & osgParticle::SegmentPlacer::getVertexB ( ) const
inline

get vertex B.

osgParticle::SegmentPlacer::META_Object ( osgParticle  ,
SegmentPlacer   
)
SegmentPlacer& osgParticle::SegmentPlacer::operator= ( const SegmentPlacer )
inlineprotected
void osgParticle::SegmentPlacer::place ( Particle P) const
inlinevirtual

Place a particle. This method is called by ModularEmitter, do not call it manually.

Implements osgParticle::Placer.

References osgParticle::Particle::setPosition().

void osgParticle::SegmentPlacer::setSegment ( const osg::Vec3 A,
const osg::Vec3 B 
)
inline

Set both vertices.

void osgParticle::SegmentPlacer::setVertexA ( const osg::Vec3 v)
inline

Set vertex A of the segment as a vector.

void osgParticle::SegmentPlacer::setVertexA ( float  x,
float  y,
float  z 
)
inline

Set vertex A of the segment as three floats.

References osg::Vec3f::set().

void osgParticle::SegmentPlacer::setVertexB ( const osg::Vec3 v)
inline

Set vertex B of the segment as a vector.

void osgParticle::SegmentPlacer::setVertexB ( float  x,
float  y,
float  z 
)
inline

Set vertex B of the segment as three floats.

References osg::Vec3f::set().

float osgParticle::SegmentPlacer::volume ( ) const
inlinevirtual

return the length of the segment

Reimplemented from osgParticle::Placer.


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

osg logo
Generated at Thu Oct 4 2012 13:45:16 for the OpenSceneGraph by doxygen 1.8.1.1.