SO3Engine
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
SO3::SParticleSystem Class Reference

#include <SO3ParticleSystem.h>

Inheritance diagram for SO3::SParticleSystem:
SO3::SNode SO3::SData

Public Member Functions

 SParticleSystem (SScene *parent, const std::string &particleSystemName, const std::string &particleTemplateName)
 
 ~SParticleSystem ()
 
Ogre::ParticleSystem * GetOgreParticleSystem ()
 
virtual void SetRenderingDistance (const float &distance)
 
virtual float GetRenderingDistance ()
 
virtual void SetScale (const Ogre::Vector3 &scale)
 
std::string GetParticleTemplateName ()
 
void SetSpeed (const float &speed)
 
float GetSpeed ()
 
void SetEnable (const bool &enable)
 
bool GetEnable ()
 
void SetPaused (const bool &pause)
 
bool GetPaused ()
 
void ClearParticles ()
 
- Public Member Functions inherited from SO3::SNode
 SNode (SScene *parent, const std::string &nodeName, const bool &isRootNode=false)
 
virtual ~SNode ()
 
SScene * GetParentScene ()
 
Ogre::SceneNode * GetOgreSceneNodePointer ()
 
Ogre::MovableObject * GetMovableObjectPointer ()
 
bool GetSceneNodeIsMouseForeground ()
 
void SetSceneNodeIsMouseForeground (const bool &mForeground)
 
bool GetSceneNodeIsMouseClick ()
 
void SetSceneNodeIsMouseClick (const bool &mClickable)
 
int GetSceneNodeMouseFlags ()
 
void SetSceneNodeMouseFlags (const int &flags)
 
bool GetSceneNodeHasBody ()
 
SBody * GetSceneNodeBody ()
 
void RestoreStaticGraph ()
 
void SetAsStaticGeometry (const bool &state)
 
bool GetAsStaticGeometry ()
 
Ogre::StaticGeometry * GetStaticGeometry ()
 
void SetFlags (const int &flags)
 
void SetPhysicsOverride (bool state)
 
bool GetPhysicsOverride ()
 
int GetFlags ()
 
void UpdateNodeBody (const bool &bScale)
 
void DisableAutoTarget ()
 
NodeType GetNodeType ()
 
void AttachToParent (SNode *newParentNode)
 
void DetachFromParent ()
 
SNode * GetParentSceneNode ()
 
const SNodeMap GetChildrenNodes () const
 
virtual int GetNumChildren ()
 
void DetachAllChildren ()
 
virtual void SetCastShadows (const bool &castShadows)
 
virtual bool GetCastShadows ()
 
virtual Ogre::Vector3 GetBoundingBoxSize (const bool &childs=false)
 
virtual Ogre::Vector3 GetBoundingBoxCenter (const bool &childs=false)
 
virtual Ogre::Vector3 GetWorldBoundingBoxSize (const bool &childs=false)
 
virtual Ogre::Vector3 GetWorldBoundingBoxCenter (const bool &childs=false)
 
virtual Ogre::Matrix4 GetTransformationMatrix ()
 
virtual Ogre::Vector3 GetPosition ()
 
virtual void SetPosition (const Ogre::Vector3 &pos)
 
virtual Ogre::Quaternion GetOrientation ()
 
virtual void SetOrientation (const Ogre::Quaternion &quat)
 
virtual void AddOrientation (const Ogre::Quaternion &quat)
 
virtual Ogre::Vector3 GetScale ()
 
virtual Ogre::Vector3 GetGlobalPosition ()
 
virtual void SetGlobalPosition (const Ogre::Vector3 &pos, bool updateBody=true)
 
virtual Ogre::Quaternion GetGlobalOrientation ()
 
virtual void SetGlobalOrientation (const Ogre::Quaternion &quat, bool updateBody=true)
 
virtual Ogre::Vector3 GetGlobalScale ()
 
virtual void SetGlobalScale (const Ogre::Vector3 &scale, bool updateBody=true)
 
virtual void StoreInitialPRS ()
 
virtual void ResetToInitialPRS ()
 
void ResetToInitialPosition ()
 
virtual void ResetToInitialOrientation ()
 
void ResetToInitialScale ()
 
virtual Ogre::Vector3 GetInitialPosition ()
 
virtual Ogre::Quaternion GetInitialOrientation ()
 
virtual Ogre::Vector3 GetInitialScale ()
 
bool GetShowBoundingBox ()
 
void SetShowBoundingBox (const bool &showBounding)
 
void SetAutoTracking (const bool &autoTrack, SNode *targetNode=0, const Ogre::Vector3 &localDirectionVector=Ogre::Vector3::NEGATIVE_UNIT_Z, const Ogre::Vector3 &offset=Ogre::Vector3::ZERO)
 
SNode * GetAutoTrackingTarget ()
 
virtual void Pitch (const float &radianAngle, const SNode::NodeTransformSpace &relativeTo=SNode::SO3_LOCAL_TS)
 
virtual void Yaw (const float &radianAngle, const SNode::NodeTransformSpace &relativeTo=SNode::SO3_LOCAL_TS)
 
virtual void Roll (const float &radianAngle, const SNode::NodeTransformSpace &relativeTo=SNode::SO3_LOCAL_TS)
 
virtual void Rotate (const Ogre::Vector3 &axis, const float &radianAngle, const SNode::NodeTransformSpace &relativeTo=SNode::SO3_LOCAL_TS)
 
virtual void Translate (const Ogre::Vector3 &d, const SNode::NodeTransformSpace &relativeTo=SNode::SO3_PARENT_TS)
 
void SetDirection (const Ogre::Vector3 &vec, const SNode::NodeTransformSpace &relativeTo=SNode::SO3_LOCAL_TS, const Ogre::Vector3 &localDirectionVector=Ogre::Vector3::NEGATIVE_UNIT_Z)
 
Ogre::Vector3 GetDirection (bool derived=false, Ogre::Vector3 axis=Ogre::Vector3::NEGATIVE_UNIT_Z)
 
void LookAt (const Ogre::Vector3 &targetPoint, const SNode::NodeTransformSpace &relativeTo, const Ogre::Vector3 &localDirectionVector=Ogre::Vector3::NEGATIVE_UNIT_Z)
 
bool GetVisible ()
 
void SetVisible (const bool &visible, const bool &cascade=true)
 
SNodeAnimation * CreateNodeAnimation (const std::string &animationName, const float &animationLength)
 
void DeleteAnimation (SAnim *existingAnimation)
 
size_t GetNumAnimations ()
 
SAnim * GetAnimation (const std::string &animationName)
 
SAnim * GetAnimation (const unsigned short &animationIndex)
 
SAnimMap GetAnimations () const
 
bool IsAnimated ()
 
Ogre::Vector3 GetPositionFromNode (SNode *nodeRef)
 
Ogre::Quaternion GetOrientationFromNode (SNode *nodeRef)
 
Ogre::Vector3 GetScaleFromNode (SNode *nodeRef)
 
virtual void SetInheritOrientation (const bool &state)
 
virtual bool GetInheritOrientation ()
 
virtual void ResetOrientation ()
 
void DeleteBody ()
 
SBody * CreateBoxBody (const Ogre::Vector3 &boxsetting)
 
SBody * CreateBoxBody (const Ogre::Vector3 &boxsetting, const Ogre::Vector3 &offset, const Ogre::Quaternion &quat)
 
SBody * CreateConeBody (const Ogre::Real &radius, const Ogre::Real &height)
 
SBody * CreateConeBody (const Ogre::Real &radius, const Ogre::Real &height, const Ogre::Vector3 &offset, const Ogre::Quaternion &quat)
 
SBody * CreateEllipsoidBody (const Ogre::Vector3 &size)
 
SBody * CreateEllipsoidBody (const Ogre::Vector3 &size, const Ogre::Vector3 &offset, const Ogre::Quaternion &quat)
 
SBody * CreateCapsuleBody (const Ogre::Real &radius, const Ogre::Real &height)
 
SBody * CreateCapsuleBody (const Ogre::Real &radius, const Ogre::Real &height, const Ogre::Vector3 &offset, const Ogre::Quaternion &quat)
 
SBody * CreateCylinderBody (const Ogre::Real &radius, const Ogre::Real &height)
 
SBody * CreateCylinderBody (const Ogre::Real &radius, const Ogre::Real &height, const Ogre::Vector3 &offset, const Ogre::Quaternion &quat)
 
SBody * CreateChamferCylinderBody (const Ogre::Real &radius, const Ogre::Real &height)
 
SBody * CreateChamferCylinderBody (const Ogre::Real &radius, const Ogre::Real &height, const Ogre::Vector3 &offset, const Ogre::Quaternion &quat)
 
SBody * CreatePyramidBody (const Ogre::Vector3 &size)
 
SBody * CreatePyramidBody (const Ogre::Vector3 &size, const Ogre::Vector3 &offset, const Ogre::Quaternion &quat)
 
SBody * CreateConvexHullBody (const Ogre::Real &tolerance)
 
SBody * CreateConcaveHullBody (const Ogre::Real &tolerance)
 
SBody * CreateTreeBody (const bool &optimize)
 
bool IsDirty ()
 
void SetDirty (bool state)
 
void UpdateNodeFromBody ()
 
void ResetNode ()
 
- Public Member Functions inherited from SO3::SData
 SData (const std::string &dataName)
 
virtual ~SData ()
 
std::string GetName () const
 
SUserObjectBindings & GetUserObjectBindings ()
 
const SUserObjectBindings & GetUserObjectBindings () const
 

Static Public Member Functions

static void ClearParticleTemplates ()
 

Protected Attributes

Ogre::ParticleSystem * O3ParticleSystem
 
string templateName
 
float speedFactor
 
bool isEnable
 
bool isPaused
 
- Protected Attributes inherited from SO3::SNode
SScene * currentScene
 
Ogre::SceneNode * O3SceneNode
 
Ogre::MovableObject * ogreMovableObject
 
SBody * nodeBody
 
unsigned short animationCounter
 
Ogre::Vector3 initialPosition
 
Ogre::Quaternion initialOrientation
 
Ogre::Vector3 initialScale
 
- Protected Attributes inherited from SO3::SData
std::string name
 

Additional Inherited Members

- Public Types inherited from SO3::SNode
enum  NodeType {
  NODE_TYPE_ID = 0 , ENTITY_TYPE_ID = 1 , CAMERA_TYPE_ID = 2 , LIGHT_TYPE_ID = 3 ,
  SKELETON_TYPE_ID = 4 , BONE_TYPE_ID = 5 , PARTICLE_SYSTEM_TYPE_ID = 6 , DYNAMIC_CUBE_MAP_ID = 7 ,
  DYNAMIC_REFLECTION_MAP_ID = 8 , RENDER_TO_TEXTURE_ID = 9 , LINE_ENTITY_TYPE_ID = 10 , VIRTUAL_POINTER_TYPE_ID = 11
}
 
enum  NodeTransformSpace { SO3_LOCAL_TS = 0 , SO3_PARENT_TS = 1 , SO3_WORLD_TS = 2 }
 
- Protected Member Functions inherited from SO3::SNode
 SNode (SScene *parent, const std::string &nodeName, const NodeType &nodeType)
 
void AddAnimation (SAnim *existingAnimation)
 
void RemoveAnimation (SAnim *existingAnimation)
 
void RemoveAnimation (const std::string &animationName)
 
Ogre::Vector3 GetSonsBoundingBox ()
 
Ogre::Vector3 GetSonsWorldBoundingBox ()
 

Detailed Description

Definition at line 43 of file SO3ParticleSystem.h.

Constructor & Destructor Documentation

◆ SParticleSystem()

SO3::SParticleSystem::SParticleSystem ( SScene *  parent,
const std::string &  particleSystemName,
const std::string &  particleTemplateName 
)

Definition at line 18 of file SO3ParticleSystem.cpp.

◆ ~SParticleSystem()

SO3::SParticleSystem::~SParticleSystem ( )

Definition at line 36 of file SO3ParticleSystem.cpp.

Member Function Documentation

◆ ClearParticles()

void SO3::SParticleSystem::ClearParticles ( )

Definition at line 128 of file SO3ParticleSystem.cpp.

◆ ClearParticleTemplates()

void SO3::SParticleSystem::ClearParticleTemplates ( )
static

Definition at line 13 of file SO3ParticleSystem.cpp.

◆ GetEnable()

bool SO3::SParticleSystem::GetEnable ( )

Definition at line 104 of file SO3ParticleSystem.cpp.

◆ GetOgreParticleSystem()

Ogre::ParticleSystem * SO3::SParticleSystem::GetOgreParticleSystem ( )

Definition at line 48 of file SO3ParticleSystem.cpp.

◆ GetParticleTemplateName()

std::string SO3::SParticleSystem::GetParticleTemplateName ( )

Definition at line 69 of file SO3ParticleSystem.cpp.

◆ GetPaused()

bool SO3::SParticleSystem::GetPaused ( )

Definition at line 123 of file SO3ParticleSystem.cpp.

◆ GetRenderingDistance()

float SO3::SParticleSystem::GetRenderingDistance ( )
virtual
Remarks
: SParticleSystem implementation, re-define from SNode .

Reimplemented from SO3::SNode.

Definition at line 58 of file SO3ParticleSystem.cpp.

◆ GetSpeed()

float SO3::SParticleSystem::GetSpeed ( )

Definition at line 81 of file SO3ParticleSystem.cpp.

◆ SetEnable()

void SO3::SParticleSystem::SetEnable ( const bool &  enable)

Definition at line 86 of file SO3ParticleSystem.cpp.

◆ SetPaused()

void SO3::SParticleSystem::SetPaused ( const bool &  pause)

Definition at line 109 of file SO3ParticleSystem.cpp.

◆ SetRenderingDistance()

void SO3::SParticleSystem::SetRenderingDistance ( const float &  distance)
virtual
Remarks
: SParticleSystem implementation, re-define from SNode .

Reimplemented from SO3::SNode.

Definition at line 53 of file SO3ParticleSystem.cpp.

◆ SetScale()

void SO3::SParticleSystem::SetScale ( const Ogre::Vector3 &  scale)
virtual

Set the node scale in local space terms.

Reimplemented from SO3::SNode.

Definition at line 63 of file SO3ParticleSystem.cpp.

◆ SetSpeed()

void SO3::SParticleSystem::SetSpeed ( const float &  speed)

Definition at line 74 of file SO3ParticleSystem.cpp.

Member Data Documentation

◆ isEnable

bool SO3::SParticleSystem::isEnable
protected

Definition at line 50 of file SO3ParticleSystem.h.

◆ isPaused

bool SO3::SParticleSystem::isPaused
protected

Definition at line 51 of file SO3ParticleSystem.h.

◆ O3ParticleSystem

Ogre::ParticleSystem* SO3::SParticleSystem::O3ParticleSystem
protected

Definition at line 47 of file SO3ParticleSystem.h.

◆ speedFactor

float SO3::SParticleSystem::speedFactor
protected

Definition at line 49 of file SO3ParticleSystem.h.

◆ templateName

string SO3::SParticleSystem::templateName
protected

Definition at line 48 of file SO3ParticleSystem.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8