Torque2D Reference
Loading...
Searching...
No Matches
ParticleAssetEmitter Class Reference

#include <ParticleAssetEmitter.h>

Inheritance diagram for ParticleAssetEmitter:

Public Types

enum  ParticleOrientationType { INVALID_ORIENTATION , FIXED_ORIENTATION , ALIGNED_ORIENTATION , RANDOM_ORIENTATION }
enum  EmitterType {
  INVALID_EMITTER_TYPE , POINT_EMITTER , LINE_EMITTER , BOX_EMITTER ,
  DISK_EMITTER , ELLIPSE_EMITTER , TORUS_EMITTER
}
enum  PhysicsParticleType {
  INVALID_PHYSICS_PARTICLE_TYPE , b2_barrierParticle , b2_colorMixingParticle , b2_destructionListenerParticle ,
  b2_elasticParticle , b2_powderParticle , b2_reactiveParticle , b2_repulsiveParticle ,
  b2_springParticle , b2_staticPressureParticle , b2_tensileParticle , b2_viscousParticle ,
  b2_wallParticle , b2_waterParticle , b2_zombieParticle
}
Public Types inherited from SimObject
enum  WriteFlags { SelectedOnly = BIT(0) }
enum  CopyFieldsFlags { CopyFields_SkipName = BIT(0) , CopyFields_SkipParentGroup = BIT(1) , CopyFields_SkipScriptClass = BIT(2) }
 What copyFieldsFrom may be told to leave alone. More...

Public Member Functions

 ParticleAssetEmitter ()
virtual ~ParticleAssetEmitter ()
virtual void copyTo (SimObject *object)
ParticleAssetgetOwner (void) const
void setEmitterName (const char *pEmitterName)
StringTableEntry getEmitterName (void) const
void setEmitterType (const EmitterType emitterType)
EmitterType getEmitterType (void)
void setEmitterOffset (const Vector2 &offset)
const Vector2getEmitterOffset (void) const
void setEmitterAngle (const F32 angle)
F32 getEmitterAngle (void) const
void setEmitterSize (const Vector2 &size)
const Vector2getEmitterSize (void) const
void setFixedAspect (const bool fixedAspect)
bool getFixedAspect (void) const
void setFixedForceAngle (const F32 fixedForceAngle)
F32 getFixedForceAngle (void) const
const Vector2getFixedForceDirection (void) const
void setOrientationType (const ParticleOrientationType particleOrientationType)
ParticleOrientationType getOrientationType (void) const
void setPhysicsParticleType (const PhysicsParticleType physicsParticleType)
PhysicsParticleType getPhysicsParticleType (void) const
void setPhysicsParticles (const bool physicsPaticle)
bool getPhysicsParticles (void) const
void setTargetPosition (const Vector2 &targetPos)
const Vector2getTargetPosition (void) const
void setIsTargeting (const bool targetParticle)
bool getIsTargeting (void) const
void setKeepAligned (const bool keepAligned)
bool getKeepAligned (void) const
void setAlignedAngleOffset (const F32 angleOffset)
F32 getAlignedAngleOffset (void) const
void setRandomAngleOffset (const F32 angleOffset)
F32 getRandomAngleOffset (void) const
void setRandomArc (const F32 arc)
F32 getRandomArc (void) const
void setFixedAngleOffset (const F32 angleOffset)
F32 getFixedAngleOffset (void) const
void setPivotPoint (const Vector2 &pivotPoint)
const Vector2getPivotPoint (void) const
void setLinkEmissionRotation (const bool linkEmissionRotation)
bool getLinkEmissionRotation (void) const
void setIntenseParticles (const bool intenseParticles)
bool getIntenseParticles (void) const
void setSingleParticle (const bool singleParticle)
bool getSingleParticle (void) const
void setAttachPositionToEmitter (const bool attachPositionToEmitter)
bool getAttachPositionToEmitter (void) const
void setAttachRotationToEmitter (const bool attachRotationToEmitter)
bool getAttachRotationToEmitter (void) const
void setOldestInFront (const bool oldestInFront)
bool getOldestInFront (void) const
bool isStaticFrameProvider (void) const
bool isUsingNamedImageFrame (void) const
bool setImage (const char *pAssetId, const U32 frame=0)
bool setImage (const char *pAssetId, const char *frameName)
StringTableEntry getImage (void) const
bool setImageFrame (const U32 frame)
U32 getImageFrame (void) const
bool setNamedImageFrame (const char *frameName)
const char * getNamedImageFrame (void) const
void setRandomImageFrame (const bool randomImageFrame)
bool getRandomImageFrame (void) const
bool setAnimation (const char *animationName)
StringTableEntry getAnimation (void) const
AssetPtr< ImageAsset > & getImageAsset (void)
AssetPtr< AnimationAsset > & getAnimationAsset (void)
void setBlendMode (bool blendMode)
bool getBlendMode (void) const
void setSrcBlendFactor (const S32 blendFactor)
S32 getSrcBlendFactor (void) const
void setDstBlendFactor (const S32 blendFactor)
S32 getDstBlendFactor (void) const
void setAlphaTest (const F32 alphaTest)
F32 getAlphaTest (void) const
ParticleAssetFieldCollectiongetParticleFields (void)
ParticleAssetFieldgetParticleLifeBaseField (void)
ParticleAssetFieldgetParticleLifeVariationField (void)
ParticleAssetFieldgetQuantityBaseField (void)
ParticleAssetFieldgetQuantityVariationField (void)
ParticleAssetFieldgetSizeXBaseField (void)
ParticleAssetFieldgetSizeXVariationField (void)
ParticleAssetFieldgetSizeXLifeField (void)
ParticleAssetFieldgetSizeYBaseField (void)
ParticleAssetFieldgetSizeYVariationField (void)
ParticleAssetFieldgetSizeYLifeField (void)
ParticleAssetFieldgetSpeedBaseField (void)
ParticleAssetFieldgetSpeedVariationField (void)
ParticleAssetFieldgetSpeedLifeField (void)
ParticleAssetFieldgetSpinBaseField (void)
ParticleAssetFieldgetSpinVariationField (void)
ParticleAssetFieldgetSpinLifeField (void)
ParticleAssetFieldgetFixedForceBaseField (void)
ParticleAssetFieldgetFixedForceVariationField (void)
ParticleAssetFieldgetFixedForceLifeField (void)
ParticleAssetFieldgetRandomMotionBaseField (void)
ParticleAssetFieldgetRandomMotionVariationField (void)
ParticleAssetFieldgetRandomMotionLifeField (void)
ParticleAssetFieldgetEmissionForceForceBaseField (void)
ParticleAssetFieldgetEmissionForceVariationField (void)
ParticleAssetFieldgetEmissionAngleBaseField (void)
ParticleAssetFieldgetEmissionAngleVariationField (void)
ParticleAssetFieldgetEmissionArcBaseField (void)
ParticleAssetFieldgetEmissionArcVariationField (void)
ParticleAssetFieldgetRedChannelLifeField (void)
ParticleAssetFieldgetGreenChannelLifeField (void)
ParticleAssetFieldgetBlueChannelLifeField (void)
ParticleAssetFieldgetAlphaChannelLifeField (void)
const Vector2getLocalPivotAABB0 (void)
const Vector2getLocalPivotAABB1 (void)
const Vector2getLocalPivotAABB2 (void)
const Vector2getLocalPivotAABB3 (void)
 DECLARE_CONOBJECT (ParticleAssetEmitter)
 Declare Console Object.
Public Member Functions inherited from SimObject
StringTableEntry getClassNamespace () const
StringTableEntry getSuperClassNamespace () const
void setClassNamespace (const char *classNamespace)
void setSuperClassNamespace (const char *superClassNamespace)
void pushScriptCallbackGuard (void)
void popScriptCallbackGuard (void)
S32 getScriptCallbackGuard (void)
virtual SimObjectfindObject (const char *name)
NamespacegetNamespace ()
 Return the object's namespace.
const char * tabComplete (const char *prevText, S32 baseLen, bool)
virtual void dump ()
virtual void dumpClassHierarchy ()
SimObjectclone (const bool copyDynamicFields)
SimObjectdeepClone ()
template<typename T>
bool isType (void)
virtual bool handlesConsoleMethod (const char *fname, S32 *routingId)
 DECLARE_CONOBJECT (SimObject)
virtual bool writeField (StringTableEntry fieldname, const char *value)
virtual void write (Stream &stream, U32 tabStop, U32 flags=0)
virtual void writeFields (Stream &stream, U32 tabStop)
virtual bool writeObject (Stream *stream)
virtual bool readObject (Stream *stream)
virtual void buildFilterList ()
void addFieldFilter (const char *fieldName)
void removeFieldFilter (const char *fieldName)
void clearFieldFilters ()
bool isFiltered (const char *fieldName)
void assignFieldsFrom (SimObject *obj)
void copyFieldsFrom (SimObject *obj, const U32 flags)
void assignDynamicFieldsFrom (SimObject *obj)
NotifyremoveNotify (void *ptr, Notify::Type)
 Remove a notification from the list.
void deleteNotify (SimObject *obj)
 Notify an object when we are deleted.
void clearNotify (SimObject *obj)
 Notify an object when we are cleared.
void clearAllNotifications ()
 Remove all notifications for this object.
void processDeleteNotifies ()
 Send out deletion notifications.
void registerReference (SimObject **obj)
void unregisterReference (SimObject **obj)
void addListener (std::string objID)
void removeListener (std::string objID)
void removeAllListeners ()
void postEvent (std::string eventName, std::string data)
const char * getDataField (StringTableEntry slotName, const char *array)
virtual void setDataField (StringTableEntry slotName, const char *array, const char *value)
const char * getPrefixedDataField (StringTableEntry fieldName, const char *array)
void setPrefixedDataField (StringTableEntry fieldName, const char *array, const char *value)
const char * getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)
void setPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const char *value, const S32 fieldType=-1)
StringTableEntry getDataFieldPrefix (StringTableEntry fieldName)
U32 getDataFieldType (StringTableEntry slotName, const char *array)
SimFieldDictionarygetFieldDictionary ()
void clearDynamicFields (void)
 Clear all dynamic fields.
void setCanSaveDynamicFields (bool bCanSave)
 Set whether fields created at runtime should be saved. Default is true.
bool getCanSaveDynamicFields (void) const
 Get whether fields created at runtime should be saved. Default is true.
void setInternalName (const char *newname)
StringTableEntry getInternalName ()
 Get the internal of of this control.
virtual bool save (const char *pcFilePath, bool bOnlySelected=false)
 Save object as a TorqueScript File.
virtual bool isMethod (const char *methodName)
 Check if a method exists in the objects current namespace.
SimObjectId getId (void) const
StringTableEntry getIdString (void) const
U32 getType () const
const StringTableEntry getName (void) const
void setId (SimObjectId id)
void assignName (const char *name)
SimGroupgetGroup () const
bool isChildOfGroup (SimGroup *pGroup)
bool isProperlyAdded () const
bool isDeleted () const
bool isRemoved () const
bool isLocked () const
void setLocked (bool b)
bool isHidden () const
void setHidden (bool b)
void setProgenitorFile (const char *pFile)
StringTableEntry getProgenitorFile (void) const
void setPeriodicTimerID (const S32 timerID)
S32 getPeriodicTimerID (void) const
bool isPeriodicTimerActive (void) const
bool isSelected () const
bool isExpanded () const
void setSelected (bool sel)
void setExpanded (bool exp)
void setModDynamicFields (bool dyn)
void setModStaticFields (bool sta)
 SimObject ()
virtual ~SimObject ()
virtual bool processArguments (S32 argc, const char **argv)
 Process constructor options. (ie, new SimObject(1,2,3)).
virtual bool onAdd ()
 Called when the object is added to the sim.
virtual void onRemove ()
 Called when the object is removed from the sim.
virtual void onGroupAdd ()
 Called when the object is added to a SimGroup.
virtual void onGroupRemove ()
 Called when the object is removed from a SimGroup.
virtual void onNameChange (const char *name)
 Called when the object's name is changed.
virtual void onStaticModified (const char *slotName, const char *newValue=NULL)
virtual void inspectPreApply ()
virtual void inspectPostApply ()
virtual void onDeleteNotify (SimObject *object)
virtual void onEditorEnable ()
 Called when the editor is activated.
virtual void onEditorDisable ()
 Called when the editor is deactivated.
bool registerObject ()
bool registerObject (U32 id)
bool registerObject (const char *name)
bool registerObject (const char *name, U32 id)
void unregisterObject ()
void deleteObject ()
bool addToSet (SimObjectId)
bool addToSet (const char *)
bool removeFromSet (SimObjectId)
bool removeFromSet (const char *)
Public Member Functions inherited from ConsoleObject
const AbstractClassRep::FieldfindField (StringTableEntry fieldName) const
 Get a reference to a field by name.
virtual AbstractClassRepgetClassRep () const
 Gets the ClassRep.
bool setField (const char *fieldName, const char *value)
 Set the value of a field.
virtual ~ConsoleObject ()
const AbstractClassRep::FieldListgetFieldList () const
 Get a list of all the fields. This information cannot be modified.
AbstractClassRep::FieldListgetModifiableFieldList ()
bool & getDynamicGroupExpand ()
S32 getClassId (U32 netClassGroup) const
const char * getClassName () const

Static Public Member Functions

static void initPersistFields ()
static EmitterType getEmitterTypeEnum (const char *label)
static const char * getEmitterTypeDescription (const EmitterType emitterType)
static PhysicsParticleType getPhysicsParticleTypeEnum (const char *label)
static const char * getPhysicsParticleTypeDescription (const PhysicsParticleType particleType)
static ParticleOrientationType getOrientationTypeEnum (const char *label)
static const char * getOrientationTypeDescription (const ParticleOrientationType orientationType)
Static Public Member Functions inherited from SimObject
static void initPersistFields ()
Static Public Member Functions inherited from ConsoleObject
static const char * lookupClassName (const U32 in_classTag)
 Get the classname from a class tag.
static void initPersistFields ()
static void consoleInit ()
static AbstractClassRepgetStaticClassRep ()
 Get the abstract class information for this class.
static AbstractClassRepgetParentStaticClassRep ()
 Get the abstract class information for this class's superclass.
static ConsoleObjectcreate (const char *in_pClassName)
static ConsoleObjectcreate (const U32 groupId, const U32 typeId, const U32 in_classId)

Protected Member Functions

virtual void onAssetRefreshed (AssetPtrBase *pAssetPtrBase)
void onTamlCustomWrite (TamlCustomNodes &customNodes)
 Called during the writing of the object to allow custom properties to be written.
void onTamlCustomRead (const TamlCustomNodes &customNodes)
 Called during the reading of the object to allow custom properties to be read.
Protected Member Functions inherited from SimObject
virtual void onTamlPreWrite (void)
 Taml callbacks.
virtual void onTamlPostWrite (void)
 Called after Taml has finished writing the object.
virtual void onTamlPreRead (void)
 Called prior to Taml reading the object.
virtual void onTamlPostRead (const TamlCustomNodes &customNodes)
virtual void onTamlAddParent (SimObject *pParentObject)
 Called after Taml has finished reading the object and has added the object to any parent.
void linkNamespaces ()
void unlinkNamespaces ()
virtual SimObjectallocClone ()
 A registered but empty object of this object's class.
void cloneInto (SimObject *clone)
virtual void deepCloneChildren (SimObject *clone)
Protected Member Functions inherited from ConsoleObject
 ConsoleObject ()
 ConsoleObject (const ConsoleObject &)

Static Protected Member Functions

static bool setEmitterName (void *obj, const char *data)
static bool setEmitterType (void *obj, const char *data)
static bool writeEmitterType (void *obj, StringTableEntry pFieldName)
static bool setEmitterOffset (void *obj, const char *data)
static bool writeEmitterOffset (void *obj, StringTableEntry pFieldName)
static bool setIsTargeting (void *obj, const char *data)
static bool writeTargetParticle (void *obj, StringTableEntry pFieldName)
static bool setTargetPosition (void *obj, const char *data)
static bool writeTargetPosition (void *obj, StringTableEntry pFieldName)
static bool setEmitterAngle (void *obj, const char *data)
static bool writeEmitterAngle (void *obj, StringTableEntry pFieldName)
static bool setEmitterSize (void *obj, const char *data)
static bool writeEmitterSize (void *obj, StringTableEntry pFieldName)
static bool setFixedAspect (void *obj, const char *data)
static bool writeFixedAspect (void *obj, StringTableEntry pFieldName)
static bool setFixedForceAngle (void *obj, const char *data)
static bool writeFixedForceAngle (void *obj, StringTableEntry pFieldName)
static bool setPhysicsParticleType (void *obj, const char *data)
static bool writePhysicsParticleType (void *obj, StringTableEntry pFieldName)
static bool setPhysicsParticles (void *obj, const char *data)
static bool writePhysicsParticles (void *obj, StringTableEntry pFieldName)
static bool setOrientationType (void *obj, const char *data)
static bool writeOrientationType (void *obj, StringTableEntry pFieldName)
static bool setKeepAligned (void *obj, const char *data)
static bool writeKeepAligned (void *obj, StringTableEntry pFieldName)
static bool setAlignedAngleOffset (void *obj, const char *data)
static bool writeAlignedAngleOffset (void *obj, StringTableEntry pFieldName)
static bool setRandomAngleOffset (void *obj, const char *data)
static bool writeRandomAngleOffset (void *obj, StringTableEntry pFieldName)
static bool setRandomArc (void *obj, const char *data)
static bool writeRandomArc (void *obj, StringTableEntry pFieldName)
static bool setFixedAngleOffset (void *obj, const char *data)
static bool writeFixedAngleOffset (void *obj, StringTableEntry pFieldName)
static bool setPivotPoint (void *obj, const char *data)
static bool writePivotPoint (void *obj, StringTableEntry pFieldName)
static bool setLinkEmissionRotation (void *obj, const char *data)
static bool writeLinkEmissionRotation (void *obj, StringTableEntry pFieldName)
static bool setIntenseParticles (void *obj, const char *data)
static bool writeIntenseParticles (void *obj, StringTableEntry pFieldName)
static bool setSingleParticle (void *obj, const char *data)
static bool writeSingleParticle (void *obj, StringTableEntry pFieldName)
static bool setAttachPositionToEmitter (void *obj, const char *data)
static bool writeAttachPositionToEmitter (void *obj, StringTableEntry pFieldName)
static bool setAttachRotationToEmitter (void *obj, const char *data)
static bool writeAttachRotationToEmitter (void *obj, StringTableEntry pFieldName)
static bool setOldestInFront (void *obj, const char *data)
static bool writeOldestInFront (void *obj, StringTableEntry pFieldName)
static bool setImage (void *obj, const char *data)
static const char * getImage (void *obj, const char *data)
static bool writeImage (void *obj, StringTableEntry pFieldName)
static bool setImageFrame (void *obj, const char *data)
static bool writeImageFrame (void *obj, StringTableEntry pFieldName)
static bool setNamedImageFrame (void *obj, const char *data)
static bool writeNamedImageFrame (void *obj, StringTableEntry pFieldName)
static bool setRandomImageFrame (void *obj, const char *data)
static bool writeRandomImageFrame (void *obj, StringTableEntry pFieldName)
static bool setAnimation (void *obj, const char *data)
static const char * getAnimation (void *obj, const char *data)
static bool writeAnimation (void *obj, StringTableEntry pFieldName)
static bool setBlendMode (void *obj, const char *data)
static bool writeBlendMode (void *obj, StringTableEntry pFieldName)
static bool setSrcBlendFactor (void *obj, const char *data)
static bool writeSrcBlendFactor (void *obj, StringTableEntry pFieldName)
static bool setDstBlendFactor (void *obj, const char *data)
static bool writeDstBlendFactor (void *obj, StringTableEntry pFieldName)
static bool setAlphaTest (void *obj, const char *data)
static bool writeAlphaTest (void *obj, StringTableEntry pFieldName)
Static Protected Member Functions inherited from SimObject
static bool setClass (void *obj, const char *data)
static bool setSuperClass (void *obj, const char *data)
static bool writeObjectName (void *obj, StringTableEntry pFieldName)
static bool writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)
static bool writeInternalName (void *obj, StringTableEntry pFieldName)
static bool setParentGroup (void *obj, const char *data)
static bool writeParentGroup (void *obj, StringTableEntry pFieldName)
static bool writeSuperclass (void *obj, StringTableEntry pFieldName)
static bool writeClass (void *obj, StringTableEntry pFieldName)
static bool setProtectedName (void *obj, const char *data)
static const char * getProtectedName (void *obj, const char *data)
static SimObject::NotifyallocNotify ()
 Get a free Notify structure.
static void freeNotify (SimObject::Notify *)
 Mark a Notify structure as free.
static void addGroup (const char *in_pGroupname, const char *in_pGroupDocs=NULL)
static void endGroup (const char *in_pGroupname)
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const char *in_pFieldDocs)
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const char *in_pFieldDocs)
static void addFieldV (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, ConsoleTypeValidator *v, const char *in_pFieldDocs=NULL)
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const char *in_pFieldDocs=NULL)
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const char *in_pFieldDocs=NULL)
static void addDepricatedField (const char *fieldName)
static bool removeField (const char *in_pFieldname)

Friends

class ParticleAsset

Additional Inherited Members

static bool disableNameChanging = false
Protected Attributes inherited from SimObject
SimObjectId mId
 Id number for this object.
StringTableEntry mIdString
NamespacemNameSpace
U32 mTypeMask
S32 mScriptCallbackGuard
 Whether the object is executing a script callback.
bool mCanSaveFieldDictionary
 true if dynamic fields (added at runtime) should be saved, defaults to true
StringTableEntry mInternalName
 Stores object Internal Name.
StringTableEntry mClassName
 Stores the class name to link script class namespaces.
StringTableEntry mSuperClassName
 Stores super class name to link script class namespaces.
static SimObject::NotifymNotifyFreeList = NULL

Member Enumeration Documentation

◆ EmitterType

Enumerator
INVALID_EMITTER_TYPE 
POINT_EMITTER 
LINE_EMITTER 
BOX_EMITTER 
DISK_EMITTER 
ELLIPSE_EMITTER 
TORUS_EMITTER 

◆ ParticleOrientationType

Enumerator
INVALID_ORIENTATION 
FIXED_ORIENTATION 
ALIGNED_ORIENTATION 
RANDOM_ORIENTATION 

◆ PhysicsParticleType

Enumerator
INVALID_PHYSICS_PARTICLE_TYPE 
b2_barrierParticle 
b2_colorMixingParticle 
b2_destructionListenerParticle 
b2_elasticParticle 
b2_powderParticle 
b2_reactiveParticle 
b2_repulsiveParticle 
b2_springParticle 
b2_staticPressureParticle 
b2_tensileParticle 
b2_viscousParticle 
b2_wallParticle 
b2_waterParticle 
b2_zombieParticle 

Constructor & Destructor Documentation

◆ ParticleAssetEmitter()

◆ ~ParticleAssetEmitter()

~ParticleAssetEmitter ( )
virtual

Member Function Documentation

◆ copyTo()

void copyTo ( SimObject * object)
virtual

Reimplemented from SimObject.

◆ DECLARE_CONOBJECT()

DECLARE_CONOBJECT ( ParticleAssetEmitter )

Declare Console Object.

◆ getAlignedAngleOffset()

F32 getAlignedAngleOffset ( void ) const
inline

◆ getAlphaChannelLifeField()

ParticleAssetField & getAlphaChannelLifeField ( void )
inline

◆ getAlphaTest()

F32 getAlphaTest ( void ) const
inline

◆ getAnimation() [1/2]

const char * getAnimation ( void * obj,
const char * data )
inlinestaticprotected

◆ getAnimation() [2/2]

StringTableEntry getAnimation ( void ) const
inline

◆ getAnimationAsset()

AssetPtr< AnimationAsset > & getAnimationAsset ( void )
inline

◆ getAttachPositionToEmitter()

bool getAttachPositionToEmitter ( void ) const
inline

◆ getAttachRotationToEmitter()

bool getAttachRotationToEmitter ( void ) const
inline

◆ getBlendMode()

bool getBlendMode ( void ) const
inline

◆ getBlueChannelLifeField()

ParticleAssetField & getBlueChannelLifeField ( void )
inline

◆ getDstBlendFactor()

S32 getDstBlendFactor ( void ) const
inline

◆ getEmissionAngleBaseField()

ParticleAssetField & getEmissionAngleBaseField ( void )
inline

◆ getEmissionAngleVariationField()

ParticleAssetField & getEmissionAngleVariationField ( void )
inline

◆ getEmissionArcBaseField()

ParticleAssetField & getEmissionArcBaseField ( void )
inline

◆ getEmissionArcVariationField()

ParticleAssetField & getEmissionArcVariationField ( void )
inline

◆ getEmissionForceForceBaseField()

ParticleAssetField & getEmissionForceForceBaseField ( void )
inline

◆ getEmissionForceVariationField()

ParticleAssetField & getEmissionForceVariationField ( void )
inline

◆ getEmitterAngle()

F32 getEmitterAngle ( void ) const
inline

◆ getEmitterName()

StringTableEntry getEmitterName ( void ) const
inline

◆ getEmitterOffset()

const Vector2 & getEmitterOffset ( void ) const
inline

◆ getEmitterSize()

const Vector2 & getEmitterSize ( void ) const
inline

◆ getEmitterType()

EmitterType getEmitterType ( void )
inline

◆ getEmitterTypeDescription()

const char * getEmitterTypeDescription ( const EmitterType emitterType)
static

◆ getEmitterTypeEnum()

ParticleAssetEmitter::EmitterType getEmitterTypeEnum ( const char * label)
static

◆ getFixedAngleOffset()

F32 getFixedAngleOffset ( void ) const
inline

◆ getFixedAspect()

bool getFixedAspect ( void ) const
inline

◆ getFixedForceAngle()

F32 getFixedForceAngle ( void ) const
inline

◆ getFixedForceBaseField()

ParticleAssetField & getFixedForceBaseField ( void )
inline

◆ getFixedForceDirection()

const Vector2 & getFixedForceDirection ( void ) const
inline

◆ getFixedForceLifeField()

ParticleAssetField & getFixedForceLifeField ( void )
inline

◆ getFixedForceVariationField()

ParticleAssetField & getFixedForceVariationField ( void )
inline

◆ getGreenChannelLifeField()

ParticleAssetField & getGreenChannelLifeField ( void )
inline

◆ getImage() [1/2]

const char * getImage ( void * obj,
const char * data )
inlinestaticprotected

◆ getImage() [2/2]

StringTableEntry getImage ( void ) const
inline

◆ getImageAsset()

AssetPtr< ImageAsset > & getImageAsset ( void )
inline

◆ getImageFrame()

U32 getImageFrame ( void ) const
inline

◆ getIntenseParticles()

bool getIntenseParticles ( void ) const
inline

◆ getIsTargeting()

bool getIsTargeting ( void ) const
inline

◆ getKeepAligned()

bool getKeepAligned ( void ) const
inline

◆ getLinkEmissionRotation()

bool getLinkEmissionRotation ( void ) const
inline

◆ getLocalPivotAABB0()

const Vector2 & getLocalPivotAABB0 ( void )
inline

◆ getLocalPivotAABB1()

const Vector2 & getLocalPivotAABB1 ( void )
inline

◆ getLocalPivotAABB2()

const Vector2 & getLocalPivotAABB2 ( void )
inline

◆ getLocalPivotAABB3()

const Vector2 & getLocalPivotAABB3 ( void )
inline

◆ getNamedImageFrame()

const char * getNamedImageFrame ( void ) const
inline

◆ getOldestInFront()

bool getOldestInFront ( void ) const
inline

◆ getOrientationType()

ParticleOrientationType getOrientationType ( void ) const
inline

◆ getOrientationTypeDescription()

const char * getOrientationTypeDescription ( const ParticleOrientationType orientationType)
static

◆ getOrientationTypeEnum()

ParticleAssetEmitter::ParticleOrientationType getOrientationTypeEnum ( const char * label)
static

◆ getOwner()

ParticleAsset * getOwner ( void ) const
inline

◆ getParticleFields()

ParticleAssetFieldCollection & getParticleFields ( void )
inline

◆ getParticleLifeBaseField()

ParticleAssetField & getParticleLifeBaseField ( void )
inline

◆ getParticleLifeVariationField()

ParticleAssetField & getParticleLifeVariationField ( void )
inline

◆ getPhysicsParticles()

bool getPhysicsParticles ( void ) const
inline

◆ getPhysicsParticleType()

PhysicsParticleType getPhysicsParticleType ( void ) const
inline

◆ getPhysicsParticleTypeDescription()

const char * getPhysicsParticleTypeDescription ( const PhysicsParticleType particleType)
static

◆ getPhysicsParticleTypeEnum()

ParticleAssetEmitter::PhysicsParticleType getPhysicsParticleTypeEnum ( const char * label)
static

◆ getPivotPoint()

const Vector2 & getPivotPoint ( void ) const
inline

◆ getQuantityBaseField()

ParticleAssetField & getQuantityBaseField ( void )
inline

◆ getQuantityVariationField()

ParticleAssetField & getQuantityVariationField ( void )
inline

◆ getRandomAngleOffset()

F32 getRandomAngleOffset ( void ) const
inline

◆ getRandomArc()

F32 getRandomArc ( void ) const
inline

◆ getRandomImageFrame()

bool getRandomImageFrame ( void ) const
inline

◆ getRandomMotionBaseField()

ParticleAssetField & getRandomMotionBaseField ( void )
inline

◆ getRandomMotionLifeField()

ParticleAssetField & getRandomMotionLifeField ( void )
inline

◆ getRandomMotionVariationField()

ParticleAssetField & getRandomMotionVariationField ( void )
inline

◆ getRedChannelLifeField()

ParticleAssetField & getRedChannelLifeField ( void )
inline

◆ getSingleParticle()

bool getSingleParticle ( void ) const
inline

◆ getSizeXBaseField()

ParticleAssetField & getSizeXBaseField ( void )
inline

◆ getSizeXLifeField()

ParticleAssetField & getSizeXLifeField ( void )
inline

◆ getSizeXVariationField()

ParticleAssetField & getSizeXVariationField ( void )
inline

◆ getSizeYBaseField()

ParticleAssetField & getSizeYBaseField ( void )
inline

◆ getSizeYLifeField()

ParticleAssetField & getSizeYLifeField ( void )
inline

◆ getSizeYVariationField()

ParticleAssetField & getSizeYVariationField ( void )
inline

◆ getSpeedBaseField()

ParticleAssetField & getSpeedBaseField ( void )
inline

◆ getSpeedLifeField()

ParticleAssetField & getSpeedLifeField ( void )
inline

◆ getSpeedVariationField()

ParticleAssetField & getSpeedVariationField ( void )
inline

◆ getSpinBaseField()

ParticleAssetField & getSpinBaseField ( void )
inline

◆ getSpinLifeField()

ParticleAssetField & getSpinLifeField ( void )
inline

◆ getSpinVariationField()

ParticleAssetField & getSpinVariationField ( void )
inline

◆ getSrcBlendFactor()

S32 getSrcBlendFactor ( void ) const
inline

◆ getTargetPosition()

const Vector2 & getTargetPosition ( void ) const
inline

◆ initPersistFields()

void initPersistFields ( )
static

◆ isStaticFrameProvider()

bool isStaticFrameProvider ( void ) const
inline

◆ isUsingNamedImageFrame()

bool isUsingNamedImageFrame ( void ) const
inline

◆ onAssetRefreshed()

void onAssetRefreshed ( AssetPtrBase * pAssetPtrBase)
protectedvirtual

Implements AssetPtrCallback.

◆ onTamlCustomRead()

void onTamlCustomRead ( const TamlCustomNodes & customNodes)
protectedvirtual

Called during the reading of the object to allow custom properties to be read.

Reimplemented from SimObject.

◆ onTamlCustomWrite()

void onTamlCustomWrite ( TamlCustomNodes & customNodes)
protectedvirtual

Called during the writing of the object to allow custom properties to be written.

Reimplemented from SimObject.

◆ setAlignedAngleOffset() [1/2]

void setAlignedAngleOffset ( const F32 angleOffset)
inline

◆ setAlignedAngleOffset() [2/2]

bool setAlignedAngleOffset ( void * obj,
const char * data )
inlinestaticprotected

◆ setAlphaTest() [1/2]

void setAlphaTest ( const F32 alphaTest)
inline

◆ setAlphaTest() [2/2]

bool setAlphaTest ( void * obj,
const char * data )
inlinestaticprotected

◆ setAnimation() [1/2]

bool setAnimation ( const char * animationName)

◆ setAnimation() [2/2]

bool setAnimation ( void * obj,
const char * data )
inlinestaticprotected

◆ setAttachPositionToEmitter() [1/2]

void setAttachPositionToEmitter ( const bool attachPositionToEmitter)
inline

◆ setAttachPositionToEmitter() [2/2]

bool setAttachPositionToEmitter ( void * obj,
const char * data )
inlinestaticprotected

◆ setAttachRotationToEmitter() [1/2]

void setAttachRotationToEmitter ( const bool attachRotationToEmitter)
inline

◆ setAttachRotationToEmitter() [2/2]

bool setAttachRotationToEmitter ( void * obj,
const char * data )
inlinestaticprotected

◆ setBlendMode() [1/2]

void setBlendMode ( bool blendMode)
inline

◆ setBlendMode() [2/2]

bool setBlendMode ( void * obj,
const char * data )
inlinestaticprotected

◆ setDstBlendFactor() [1/2]

void setDstBlendFactor ( const S32 blendFactor)
inline

◆ setDstBlendFactor() [2/2]

bool setDstBlendFactor ( void * obj,
const char * data )
inlinestaticprotected

◆ setEmitterAngle() [1/2]

void setEmitterAngle ( const F32 angle)
inline

◆ setEmitterAngle() [2/2]

bool setEmitterAngle ( void * obj,
const char * data )
inlinestaticprotected

◆ setEmitterName() [1/2]

void setEmitterName ( const char * pEmitterName)

◆ setEmitterName() [2/2]

bool setEmitterName ( void * obj,
const char * data )
inlinestaticprotected

◆ setEmitterOffset() [1/2]

void setEmitterOffset ( const Vector2 & offset)
inline

◆ setEmitterOffset() [2/2]

bool setEmitterOffset ( void * obj,
const char * data )
inlinestaticprotected

◆ setEmitterSize() [1/2]

void setEmitterSize ( const Vector2 & size)
inline

◆ setEmitterSize() [2/2]

bool setEmitterSize ( void * obj,
const char * data )
inlinestaticprotected

◆ setEmitterType() [1/2]

void setEmitterType ( const EmitterType emitterType)
inline

◆ setEmitterType() [2/2]

bool setEmitterType ( void * obj,
const char * data )
inlinestaticprotected

◆ setFixedAngleOffset() [1/2]

void setFixedAngleOffset ( const F32 angleOffset)
inline

◆ setFixedAngleOffset() [2/2]

bool setFixedAngleOffset ( void * obj,
const char * data )
inlinestaticprotected

◆ setFixedAspect() [1/2]

void setFixedAspect ( const bool fixedAspect)
inline

◆ setFixedAspect() [2/2]

bool setFixedAspect ( void * obj,
const char * data )
inlinestaticprotected

◆ setFixedForceAngle() [1/2]

void setFixedForceAngle ( const F32 fixedForceAngle)

◆ setFixedForceAngle() [2/2]

bool setFixedForceAngle ( void * obj,
const char * data )
inlinestaticprotected

◆ setImage() [1/3]

bool setImage ( const char * pAssetId,
const char * frameName )

◆ setImage() [2/3]

bool setImage ( const char * pAssetId,
const U32 frame = 0 )

◆ setImage() [3/3]

bool setImage ( void * obj,
const char * data )
inlinestaticprotected

◆ setImageFrame() [1/2]

bool setImageFrame ( const U32 frame)

◆ setImageFrame() [2/2]

bool setImageFrame ( void * obj,
const char * data )
inlinestaticprotected

◆ setIntenseParticles() [1/2]

void setIntenseParticles ( const bool intenseParticles)
inline

◆ setIntenseParticles() [2/2]

bool setIntenseParticles ( void * obj,
const char * data )
inlinestaticprotected

◆ setIsTargeting() [1/2]

void setIsTargeting ( const bool targetParticle)
inline

◆ setIsTargeting() [2/2]

bool setIsTargeting ( void * obj,
const char * data )
inlinestaticprotected

◆ setKeepAligned() [1/2]

void setKeepAligned ( const bool keepAligned)
inline

◆ setKeepAligned() [2/2]

bool setKeepAligned ( void * obj,
const char * data )
inlinestaticprotected

◆ setLinkEmissionRotation() [1/2]

void setLinkEmissionRotation ( const bool linkEmissionRotation)
inline

◆ setLinkEmissionRotation() [2/2]

bool setLinkEmissionRotation ( void * obj,
const char * data )
inlinestaticprotected

◆ setNamedImageFrame() [1/2]

bool setNamedImageFrame ( const char * frameName)

◆ setNamedImageFrame() [2/2]

bool setNamedImageFrame ( void * obj,
const char * data )
inlinestaticprotected

◆ setOldestInFront() [1/2]

void setOldestInFront ( const bool oldestInFront)
inline

◆ setOldestInFront() [2/2]

bool setOldestInFront ( void * obj,
const char * data )
inlinestaticprotected

◆ setOrientationType() [1/2]

void setOrientationType ( const ParticleOrientationType particleOrientationType)
inline

◆ setOrientationType() [2/2]

bool setOrientationType ( void * obj,
const char * data )
inlinestaticprotected

◆ setPhysicsParticles() [1/2]

void setPhysicsParticles ( const bool physicsPaticle)
inline

◆ setPhysicsParticles() [2/2]

bool setPhysicsParticles ( void * obj,
const char * data )
inlinestaticprotected

◆ setPhysicsParticleType() [1/2]

void setPhysicsParticleType ( const PhysicsParticleType physicsParticleType)
inline

◆ setPhysicsParticleType() [2/2]

bool setPhysicsParticleType ( void * obj,
const char * data )
inlinestaticprotected

◆ setPivotPoint() [1/2]

void setPivotPoint ( const Vector2 & pivotPoint)

◆ setPivotPoint() [2/2]

bool setPivotPoint ( void * obj,
const char * data )
inlinestaticprotected

◆ setRandomAngleOffset() [1/2]

void setRandomAngleOffset ( const F32 angleOffset)
inline

◆ setRandomAngleOffset() [2/2]

bool setRandomAngleOffset ( void * obj,
const char * data )
inlinestaticprotected

◆ setRandomArc() [1/2]

void setRandomArc ( const F32 arc)
inline

◆ setRandomArc() [2/2]

bool setRandomArc ( void * obj,
const char * data )
inlinestaticprotected

◆ setRandomImageFrame() [1/2]

void setRandomImageFrame ( const bool randomImageFrame)
inline

◆ setRandomImageFrame() [2/2]

bool setRandomImageFrame ( void * obj,
const char * data )
inlinestaticprotected

◆ setSingleParticle() [1/2]

void setSingleParticle ( const bool singleParticle)
inline

◆ setSingleParticle() [2/2]

bool setSingleParticle ( void * obj,
const char * data )
inlinestaticprotected

◆ setSrcBlendFactor() [1/2]

void setSrcBlendFactor ( const S32 blendFactor)
inline

◆ setSrcBlendFactor() [2/2]

bool setSrcBlendFactor ( void * obj,
const char * data )
inlinestaticprotected

◆ setTargetPosition() [1/2]

void setTargetPosition ( const Vector2 & targetPos)
inline

◆ setTargetPosition() [2/2]

bool setTargetPosition ( void * obj,
const char * data )
inlinestaticprotected

◆ writeAlignedAngleOffset()

bool writeAlignedAngleOffset ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeAlphaTest()

bool writeAlphaTest ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeAnimation()

bool writeAnimation ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeAttachPositionToEmitter()

bool writeAttachPositionToEmitter ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeAttachRotationToEmitter()

bool writeAttachRotationToEmitter ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeBlendMode()

bool writeBlendMode ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeDstBlendFactor()

bool writeDstBlendFactor ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeEmitterAngle()

bool writeEmitterAngle ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeEmitterOffset()

bool writeEmitterOffset ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeEmitterSize()

bool writeEmitterSize ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeEmitterType()

bool writeEmitterType ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeFixedAngleOffset()

bool writeFixedAngleOffset ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeFixedAspect()

bool writeFixedAspect ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeFixedForceAngle()

bool writeFixedForceAngle ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeImage()

bool writeImage ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeImageFrame()

bool writeImageFrame ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeIntenseParticles()

bool writeIntenseParticles ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeKeepAligned()

bool writeKeepAligned ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeLinkEmissionRotation()

bool writeLinkEmissionRotation ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeNamedImageFrame()

bool writeNamedImageFrame ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeOldestInFront()

bool writeOldestInFront ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeOrientationType()

bool writeOrientationType ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writePhysicsParticles()

bool writePhysicsParticles ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writePhysicsParticleType()

bool writePhysicsParticleType ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writePivotPoint()

bool writePivotPoint ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeRandomAngleOffset()

bool writeRandomAngleOffset ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeRandomArc()

bool writeRandomArc ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeRandomImageFrame()

bool writeRandomImageFrame ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeSingleParticle()

bool writeSingleParticle ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeSrcBlendFactor()

bool writeSrcBlendFactor ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeTargetParticle()

bool writeTargetParticle ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ writeTargetPosition()

bool writeTargetPosition ( void * obj,
StringTableEntry pFieldName )
inlinestaticprotected

◆ ParticleAsset

friend class ParticleAsset
friend

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