PeriDyno 1.0.0
Loading...
Searching...
No Matches
dyno::ParticleEmitter< TDataType > Class Template Reference

#include <ParticleEmitter.h>

Inheritance diagram for dyno::ParticleEmitter< TDataType >:
Collaboration diagram for dyno::ParticleEmitter< TDataType >:

Public Types

typedef TDataType::Real Real
 
typedef TDataType::Coord Coord
 
- Public Types inherited from dyno::ParametricModel< TDataType >
typedef TDataType::Real Real
 
typedef TDataType::Coord Coord
 
- Public Types inherited from dyno::Node
template<class T>
using SPtr = std::shared_ptr<T>
 
- Public Types inherited from dyno::OBase
typedef std::vector< FBase * > FieldVector
 
typedef std::map< FieldID, FBase * > FieldMap
 
- Public Types inherited from dyno::ParametricModel< DataType3f >
typedef DataType3f::Real Real
 
typedef DataType3f::Coord Coord
 

Public Member Functions

 ParticleEmitter ()
 
 ~ParticleEmitter () override
 
uint sizeOfParticles ()
 
DArray< Coord > & getPositions ()
 
DArray< Coord > & getVelocities ()
 
std::string getNodeType () override
 
 DEF_VAR (Real, VelocityMagnitude, 1, "Emitter Velocity")
 
 DEF_VAR (Real, SamplingDistance, 0.005, "Emitter Sampling Distance")
 
 DEF_VAR (Real, Spacing, Real(1), "A variable to control the particle generation frequency")
 
 ParticleEmitter ()
 
virtual ~ParticleEmitter ()
 
uint sizeOfParticles ()
 
DArray< Vec3f > & getPositions ()
 
DArray< Vec3f > & getVelocities ()
 
std::string getNodeType () override
 
 DEF_VAR (float, VelocityMagnitude, 1.0f, "Emitter Velocity")
 
 DEF_VAR (float, SamplingDistance, 0.005f, "Emitter Sampling Distance")
 
- Public Member Functions inherited from dyno::ParametricModel< TDataType >
 ParametricModel ()
 
Quat< RealcomputeQuaternion ()
 
 DEF_VAR (Coord, Location, 0, "Node location")
 
 DEF_VAR (Coord, Rotation, 0, "Node rotation")
 
 DEF_VAR (Coord, Scale, Coord(1), "Node scale")
 
- Public Member Functions inherited from dyno::Node
 Node ()
 
 ~Node () override
 
void setName (std::string name)
 
std::string getName () override
 
bool isAutoSync ()
 
bool isAutoHidden ()
 
void setAutoSync (bool con)
 Whether the node can be automatically synchronized when its ancestor is updated.
 
void setAutoHidden (bool con)
 
virtual bool isActive ()
 Check the state of dynamics.
 
virtual void setActive (bool active)
 Set the state of dynamics.
 
virtual bool isVisible ()
 Check the visibility of context.
 
virtual void setVisible (bool visible)
 Set the visibility of context.
 
virtual Real getDt ()
 Simulation timestep.
 
void setDt (Real dt)
 
void setSceneGraph (SceneGraph *scn)
 
SceneGraphgetSceneGraph ()
 
std::vector< NodePort * > & getImportNodes ()
 
std::vector< NodePort * > & getExportNodes ()
 
bool addModule (std::shared_ptr< Module > module)
 Add a module to m_module_list and other special module lists.
 
bool deleteModule (std::shared_ptr< Module > module)
 
template<class TModule>
bool addModule (std::shared_ptr< TModule > tModule)
 Add a speical kind of module.
 
template<class TModule>
bool deleteModule (std::shared_ptr< TModule > tModule)
 
std::list< std::shared_ptr< Module > > & getModuleList ()
 
bool hasModule (std::string name)
 
std::shared_ptr< ModulegetModule (std::string name)
 Get a module by its name.
 
template<class TModule>
std::shared_ptr< TModule > getModule ()
 Get the Module by the module class name.
 
template<class TModule>
std::shared_ptr< TModule > getModule (std::string name)
 
std::shared_ptr< PipelineresetPipeline ()
 
std::shared_ptr< AnimationPipelineanimationPipeline ()
 
std::shared_ptr< GraphicsPipelinegraphicsPipeline ()
 
template<class TModule>
std::shared_ptr< TModule > addModule (std::string name)
 
void update ()
 Called every time interval.
 
void updateGraphicsContext ()
 
void reset ()
 
virtual NBoundingBox boundingBox ()
 
bool connect (NodePort *nPort)
 Depth-first tree traversal.
 
bool disconnect (NodePort *nPort)
 
bool attachField (FBase *field, std::string name, std::string desc, bool autoDestroy=true) override
 Attach a field to Node.
 
std::vector< NodePort * > & getAllNodePorts ()
 
uint sizeOfNodePorts ()
 
uint sizeOfImportNodes () const
 
uint sizeOfExportNodes () const
 
void setForceUpdate (bool b)
 
 DEF_VAR_STATE (Real, ElapsedTime, 0, "Elapsed Time")
 
 DEF_VAR_STATE (Real, TimeStep, Real(0.033), "Time step size")
 
 DEF_VAR_STATE (uint, FrameNumber, 0, "Frame number")
 
- Public Member Functions inherited from dyno::OBase
 OBase ()
 
 ~OBase () override
 
virtual std::string caption ()
 Return the caption.
 
virtual bool captionVisible ()
 Whether to hide the caption in the GUI.
 
virtual std::string description ()
 Return a description for the node or module, override this function to support user-defined description.
 
bool addField (FBase *data)
 Add a field to Base FieldID will be set to the name of Field by default.
 
bool addField (FieldID name, FBase *data)
 Add a field to Base.
 
bool addFieldAlias (FieldID name, FBase *data)
 
bool addFieldAlias (FieldID name, FBase *data, FieldMap &fieldAlias)
 
bool findField (FBase *data)
 Find a field by its pointer.
 
bool findFieldAlias (const FieldID name)
 Find a field by its name.
 
bool findFieldAlias (const FieldID name, FieldMap &fieldAlias)
 Find a field in fieldAlias by its name This function is typically called by other functions.
 
bool removeField (FBase *data)
 Remove a field by its pointer.
 
bool removeFieldAlias (const FieldID name)
 Remove a field by its name.
 
bool removeFieldAlias (const FieldID name, FieldMap &fieldAlias)
 
FBasegetField (const FieldID name)
 Return a field by its name.
 
std::vector< FBase * > & getAllFields ()
 
template<typename T>
TgetField (FieldID name)
 
bool isAllFieldsReady ()
 Check the completeness of all required fields.
 
std::vector< FieldIDgetFieldAlias (FBase *data)
 
int getFieldAliasCount (FBase *data)
 
void setBlockCoord (float x, float y)
 
float bx ()
 
float by ()
 
bool findInputField (FBase *field)
 
bool addInputField (FBase *field)
 
bool removeInputField (FBase *field)
 
std::vector< FBase * > & getInputFields ()
 
bool findOutputField (FBase *field)
 
bool addOutputField (FBase *field)
 
bool addToOutput (FBase *field)
 
bool removeOutputField (FBase *field)
 
bool removeFromOutput (FBase *field)
 
std::vector< FBase * > & getOutputFields ()
 
bool findParameter (FBase *field)
 
bool addParameter (FBase *field)
 
bool removeParameter (FBase *field)
 
std::vector< FBase * > & getParameters ()
 
- Public Member Functions inherited from dyno::Object
 Object ()
 
virtual ~Object ()
 
ObjectId objectId ()
 
- Public Member Functions inherited from dyno::ParametricModel< DataType3f >
 ParametricModel ()
 
Quat< RealcomputeQuaternion ()
 
 DEF_VAR (Coord, Location, 0, "Node location")
 
 DEF_VAR (Coord, Rotation, 0, "Node rotation")
 
 DEF_VAR (Coord, Scale, Coord(1), "Node scale")
 

Protected Member Functions

void resetStates () override
 
void updateStates () final
 
virtual void generateParticles ()
 
SquareMatrix< Real, 3 > rotationMatrix ()
 
void updateStates () final
 
virtual void generateParticles ()
 
SquareMatrix< float, 3 > rotationMatrix ()
 
- Protected Member Functions inherited from dyno::Node
bool appendExportNode (NodePort *nodePort)
 
bool removeExportNode (NodePort *nodePort)
 
virtual void preUpdateStates ()
 
virtual void postUpdateStates ()
 
virtual void updateTopology ()
 
virtual bool validateInputs ()
 
virtual bool requireUpdate ()
 
void tick ()
 notify all state and output fields are updated
 

Protected Attributes

DArray< CoordmPosition
 
DArray< CoordmVelocity
 
Real mTimeInterval = 0
 
DArray< Vec3fmPosition
 
DArray< Vec3fmVelocity
 
- Protected Attributes inherited from dyno::OBase
std::vector< FBase * > fields_input
 
std::vector< FBase * > fields_output
 
std::vector< FBase * > fields_param
 

Additional Inherited Members

- Static Public Member Functions inherited from dyno::Object
static bool registerClass (ClassInfo *ci)
 
static ObjectcreateObject (std::string name)
 
static std::map< std::string, ClassInfo * > * getClassMap ()
 
static ObjectId baseId ()
 Base Id.
 
- Public Attributes inherited from dyno::Node
std::string m_node_name
 

Detailed Description

template<typename TDataType>
class dyno::ParticleEmitter< TDataType >

Definition at line 26 of file ParticleEmitter.h.

Member Typedef Documentation

◆ Coord

template<typename TDataType>
typedef TDataType::Coord dyno::ParticleEmitter< TDataType >::Coord

Definition at line 30 of file ParticleEmitter.h.

◆ Real

template<typename TDataType>
typedef TDataType::Real dyno::ParticleEmitter< TDataType >::Real

Definition at line 29 of file ParticleEmitter.h.

Constructor & Destructor Documentation

◆ ParticleEmitter() [1/2]

template<typename TDataType>
dyno::ParticleEmitter< TDataType >::ParticleEmitter ( )

Definition at line 6 of file ParticleEmitter.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~ParticleEmitter() [1/2]

template<typename TDataType>
dyno::ParticleEmitter< TDataType >::~ParticleEmitter ( )
override

Definition at line 18 of file ParticleEmitter.cpp.

◆ ParticleEmitter() [2/2]

template<typename TDataType>
dyno::ParticleEmitter< TDataType >::ParticleEmitter ( )

◆ ~ParticleEmitter() [2/2]

template<typename TDataType>
virtual dyno::ParticleEmitter< TDataType >::~ParticleEmitter ( )
virtual

Member Function Documentation

◆ DEF_VAR() [1/5]

template<typename TDataType>
dyno::ParticleEmitter< TDataType >::DEF_VAR ( float ,
SamplingDistance ,
0. 005f,
"Emitter Sampling Distance"  )

◆ DEF_VAR() [2/5]

template<typename TDataType>
dyno::ParticleEmitter< TDataType >::DEF_VAR ( float ,
VelocityMagnitude ,
1. 0f,
"Emitter Velocity"  )

◆ DEF_VAR() [3/5]

template<typename TDataType>
dyno::ParticleEmitter< TDataType >::DEF_VAR ( Real ,
SamplingDistance ,
0. 005,
"Emitter Sampling Distance"  )

◆ DEF_VAR() [4/5]

template<typename TDataType>
dyno::ParticleEmitter< TDataType >::DEF_VAR ( Real ,
Spacing ,
Real(1) ,
"A variable to control the particle generation frequency"  )
Here is the call graph for this function:

◆ DEF_VAR() [5/5]

template<typename TDataType>
dyno::ParticleEmitter< TDataType >::DEF_VAR ( Real ,
VelocityMagnitude ,
1 ,
"Emitter Velocity"  )

◆ generateParticles() [1/2]

template<typename TDataType>
void dyno::ParticleEmitter< TDataType >::generateParticles ( )
protectedvirtual

Reimplemented in dyno::CircularEmitter< TDataType >, dyno::PoissonEmitter< TDataType >, dyno::SquareEmitter< TDataType >, and dyno::SquareEmitter< TDataType >.

Definition at line 25 of file ParticleEmitter.cpp.

Here is the caller graph for this function:

◆ generateParticles() [2/2]

template<typename TDataType>
virtual void dyno::ParticleEmitter< TDataType >::generateParticles ( )
protectedvirtual

◆ getNodeType() [1/2]

template<typename TDataType>
std::string dyno::ParticleEmitter< TDataType >::getNodeType ( )
overridevirtual

Reimplemented from dyno::Node.

Definition at line 55 of file ParticleEmitter.cpp.

◆ getNodeType() [2/2]

template<typename TDataType>
std::string dyno::ParticleEmitter< TDataType >::getNodeType ( )
overridevirtual

Reimplemented from dyno::Node.

◆ getPositions() [1/2]

template<typename TDataType>
DArray< Coord > & dyno::ParticleEmitter< TDataType >::getPositions ( )
inline

Definition at line 37 of file ParticleEmitter.h.

◆ getPositions() [2/2]

template<typename TDataType>
DArray< Vec3f > & dyno::ParticleEmitter< TDataType >::getPositions ( )
inline

Definition at line 33 of file ParticleEmitter.h.

◆ getVelocities() [1/2]

template<typename TDataType>
DArray< Coord > & dyno::ParticleEmitter< TDataType >::getVelocities ( )
inline

Definition at line 38 of file ParticleEmitter.h.

◆ getVelocities() [2/2]

template<typename TDataType>
DArray< Vec3f > & dyno::ParticleEmitter< TDataType >::getVelocities ( )
inline

Definition at line 34 of file ParticleEmitter.h.

◆ resetStates()

template<typename TDataType>
void dyno::ParticleEmitter< TDataType >::resetStates ( )
overrideprotectedvirtual

Reimplemented from dyno::Node.

Reimplemented in dyno::PoissonEmitter< TDataType >, dyno::SquareEmitter< TDataType >, and dyno::SquareEmitter< TDataType >.

Definition at line 31 of file ParticleEmitter.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ rotationMatrix() [1/2]

template<typename TDataType>
SquareMatrix< Real, 3 > dyno::ParticleEmitter< TDataType >::rotationMatrix ( )
inlineprotected

Definition at line 57 of file ParticleEmitter.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ rotationMatrix() [2/2]

template<typename TDataType>
SquareMatrix< float, 3 > dyno::ParticleEmitter< TDataType >::rotationMatrix ( )
inlineprotected

Definition at line 47 of file ParticleEmitter.h.

Here is the call graph for this function:

◆ sizeOfParticles() [1/2]

template<typename TDataType>
uint dyno::ParticleEmitter< TDataType >::sizeOfParticles ( )
inline

Definition at line 35 of file ParticleEmitter.h.

◆ sizeOfParticles() [2/2]

template<typename TDataType>
uint dyno::ParticleEmitter< TDataType >::sizeOfParticles ( )
inline

Definition at line 31 of file ParticleEmitter.h.

◆ updateStates() [1/2]

template<typename TDataType>
void dyno::ParticleEmitter< TDataType >::updateStates ( )
finalprotectedvirtual

Reimplemented from dyno::Node.

Definition at line 39 of file ParticleEmitter.cpp.

Here is the call graph for this function:

◆ updateStates() [2/2]

template<typename TDataType>
void dyno::ParticleEmitter< TDataType >::updateStates ( )
finalprotectedvirtual

Reimplemented from dyno::Node.

Member Data Documentation

◆ mPosition [1/2]

template<typename TDataType>
DArray<Coord> dyno::ParticleEmitter< TDataType >::mPosition
protected

Definition at line 75 of file ParticleEmitter.h.

◆ mPosition [2/2]

template<typename TDataType>
DArray<Vec3f> dyno::ParticleEmitter< TDataType >::mPosition
protected

Definition at line 65 of file ParticleEmitter.h.

◆ mTimeInterval

template<typename TDataType>
Real dyno::ParticleEmitter< TDataType >::mTimeInterval = 0
protected

Definition at line 78 of file ParticleEmitter.h.

◆ mVelocity [1/2]

template<typename TDataType>
DArray<Coord> dyno::ParticleEmitter< TDataType >::mVelocity
protected

Definition at line 76 of file ParticleEmitter.h.

◆ mVelocity [2/2]

template<typename TDataType>
DArray<Vec3f> dyno::ParticleEmitter< TDataType >::mVelocity
protected

Definition at line 66 of file ParticleEmitter.h.


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