OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | List of all members
osgParticle::SegmentPlacer Class Reference

#include <SegmentPlacer.h>

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

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. More...
 
void setVertexA (const osg::Vec3 &v)
 Set vertex A of the segment as a vector. More...
 
void setVertexA (float x, float y, float z)
 Set vertex A of the segment as three floats. More...
 
const osg::Vec3getVertexB () const
 get vertex B. More...
 
void setVertexB (const osg::Vec3 &v)
 Set vertex B of the segment as a vector. More...
 
void setVertexB (float x, float y, float z)
 Set vertex B of the segment as three floats. More...
 
void setSegment (const osg::Vec3 &A, const osg::Vec3 &B)
 Set both vertices. More...
 
void place (Particle *P) const
 Place a particle. This method is called by ModularEmitter, do not call it manually. More...
 
float volume () const
 return the length of the segment More...
 
osg::Vec3 getControlPosition () const
 return the control position More...
 
- 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
 
virtual const char * className () const
 
virtual bool isSameKindAs (const osg::Object *obj) const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
virtual void resizeGLObjectBuffers (unsigned int)
 
virtual void releaseGLObjects (osg::State *=0) const
 
template<typename T >
BoolValueObject
UCharValueObject
UShortValueObject
UIntValueObject
DoubleValueObject
Vec3fValueObject
Vec2dValueObject
Vec4dValueObject
PlaneValueObject
MatrixdValueObject
BoundingBoxdValueObject
BoundingSpheredValueObject
bool 
getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

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 ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Additional Inherited Members

- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 
- 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
 

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.

Definition at line 32 of file SegmentPlacer.h.

Constructor & Destructor Documentation

osgParticle::SegmentPlacer::SegmentPlacer ( )
inline

Definition at line 80 of file SegmentPlacer.h.

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

Definition at line 85 of file SegmentPlacer.h.

virtual osgParticle::SegmentPlacer::~SegmentPlacer ( )
inlineprotectedvirtual

Definition at line 70 of file SegmentPlacer.h.

Member Function Documentation

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

return the control position

Implements osgParticle::Placer.

Definition at line 136 of file SegmentPlacer.h.

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

get vertex A.

Definition at line 90 of file SegmentPlacer.h.

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

get vertex B.

Definition at line 95 of file SegmentPlacer.h.

osgParticle::SegmentPlacer::META_Object ( osgParticle  ,
SegmentPlacer   
)
SegmentPlacer& osgParticle::SegmentPlacer::operator= ( const SegmentPlacer )
inlineprotected

Definition at line 71 of file SegmentPlacer.h.

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.

Definition at line 106 of file SegmentPlacer.h.

Here is the call graph for this function:

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

Set both vertices.

Definition at line 100 of file SegmentPlacer.h.

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

Set vertex A of the segment as a vector.

Definition at line 116 of file SegmentPlacer.h.

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

Set vertex A of the segment as three floats.

Definition at line 121 of file SegmentPlacer.h.

Here is the call graph for this function:

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

Set vertex B of the segment as a vector.

Definition at line 126 of file SegmentPlacer.h.

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

Set vertex B of the segment as three floats.

Definition at line 131 of file SegmentPlacer.h.

Here is the call graph for this function:

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

return the length of the segment

Reimplemented from osgParticle::Placer.

Definition at line 111 of file SegmentPlacer.h.


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