Torque2D Reference
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
ParticleAsset Class Reference

#include <ParticleAsset.h>

+ Inheritance diagram for ParticleAsset:

Public Types

enum  LifeMode {
  INVALID_LIFEMODE, INFINITE, CYCLE, STOP,
  KILL
}
 Life Mode. More...
 
- Public Types inherited from SimObject
enum  WriteFlags { SelectedOnly = BIT(0) }
 

Public Member Functions

 ParticleAsset ()
 
virtual ~ParticleAsset ()
 
virtual void copyTo (SimObject *object)
 
virtual void onDeleteNotify (SimObject *object)
 
virtual bool isAssetValid (void) const
 
void setLifetime (const F32 lifetime)
 
F32 getLifetime (void) const
 
void setLifeMode (const LifeMode lifemode)
 
LifeMode getLifeMode (void) const
 
ParticleAssetFieldCollectiongetParticleFields (void)
 
ParticleAssetFieldgetParticleLifeScaleField (void)
 
ParticleAssetFieldgetQuantityScaleField (void)
 
ParticleAssetFieldgetSizeXScaleField (void)
 
ParticleAssetFieldgetSizeYScaleField (void)
 
ParticleAssetFieldgetSpeedScaleField (void)
 
ParticleAssetFieldgetSpinScaleField (void)
 
ParticleAssetFieldgetFixedForceScaleField (void)
 
ParticleAssetFieldgetRandomMotionScaleField (void)
 
ParticleAssetFieldgetAlphaChannelScaleField (void)
 
ParticleAssetEmittercreateEmitter (void)
 
bool addEmitter (ParticleAssetEmitter *pParticleAssetEmitter)
 
void removeEmitter (ParticleAssetEmitter *pParticleAssetEmitter, const bool deleteEmitter=true)
 
void clearEmitters (void)
 
U32 getEmitterCount (void) const
 
ParticleAssetEmittergetEmitter (const U32 emitterIndex) const
 
ParticleAssetEmitterfindEmitter (const char *pEmitterName) const
 
void moveEmitter (S32 fromIndex, S32 toIndex)
 
virtual U32 getTamlChildCount (void) const
 Called when Taml attempts to compile a list of children. More...
 
virtual SimObjectgetTamlChild (const U32 childIndex) const
 Called when Taml attempts to compile a list of children. More...
 
virtual void addTamlChild (SimObject *pSimObject)
 Called when Taml attempts to populate an objects children during a read. More...
 
 DECLARE_CONOBJECT (ParticleAsset)
 Declare Console Object. More...
 
- Public Member Functions inherited from AssetBase
 AssetBase ()
 
virtual ~AssetBase ()
 
void setAssetName (const char *pAssetName)
 Asset configuration. More...
 
StringTableEntry getAssetName (void) const
 
void setAssetDescription (const char *pAssetDescription)
 
StringTableEntry getAssetDescription (void) const
 
void setAssetCategory (const char *pAssetCategory)
 
StringTableEntry getAssetCategory (void) const
 
void setAssetAutoUnload (const bool autoUnload)
 
bool getAssetAutoUnload (void) const
 
void setAssetInternal (const bool assetInternal)
 
bool getAssetInternal (void) const
 
bool getAssetPrivate (void) const
 
StringTableEntry getAssetType (void) const
 
S32 getAcquiredReferenceCount (void) const
 
bool getOwned (void) const
 
StringTableEntry getAssetId (void) const
 
StringTableEntry expandAssetFilePath (const char *pAssetFilePath) const
 Expanding/Collapsing asset paths is only available once registered with the asset manager. More...
 
StringTableEntry collapseAssetFilePath (const char *pAssetFilePath) const
 
void refreshAsset (void)
 
 DECLARE_CONOBJECT (AssetBase)
 Declare Console Object. More...
 
- 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. More...
 
const char * tabComplete (const char *prevText, S32 baseLen, bool)
 
virtual void dump ()
 
virtual void dumpClassHierarchy ()
 
SimObjectclone (const bool copyDynamicFields)
 
template<typename T >
bool isType (void)
 
virtual bool handlesConsoleMethod (const char *fname, S32 *routingId)
 
 DECLARE_CONOBJECT (SimObject)
 
NotifyremoveNotify (void *ptr, Notify::Type)
 Remove a notification from the list. More...
 
void deleteNotify (SimObject *obj)
 Notify an object when we are deleted. More...
 
void clearNotify (SimObject *obj)
 Notify an object when we are cleared. More...
 
void clearAllNotifications ()
 Remove all notifications for this object. More...
 
void processDeleteNotifies ()
 Send out deletion notifications. More...
 
void registerReference (SimObject **obj)
 
void unregisterReference (SimObject **obj)
 
const char * getDataField (StringTableEntry slotName, const char *array)
 
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. More...
 
void setCanSaveDynamicFields (bool bCanSave)
 Set whether fields created at runtime should be saved. Default is true. More...
 
bool getCanSaveDynamicFields (void) const
 Get whether fields created at runtime should be saved. Default is true. More...
 
void setInternalName (const char *newname)
 
StringTableEntry getInternalName ()
 Get the internal of of this control. More...
 
virtual bool save (const char *pcFilePath, bool bOnlySelected=false)
 Save object as a TorqueScript File. More...
 
virtual bool isMethod (const char *methodName)
 Check if a method exists in the objects current namespace. More...
 
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 ()
 
void setLocked (bool b)
 
bool isHidden ()
 
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)) More...
 
virtual bool onAdd ()
 Called when the object is added to the sim. More...
 
virtual void onRemove ()
 Called when the object is removed from the sim. More...
 
virtual void onGroupAdd ()
 Called when the object is added to a SimGroup. More...
 
virtual void onGroupRemove ()
 Called when the object is removed from a SimGroup. More...
 
virtual void onNameChange (const char *name)
 Called when the object's name is changed. More...
 
virtual void onStaticModified (const char *slotName, const char *newValue=NULL)
 
virtual void inspectPreApply ()
 
virtual void inspectPostApply ()
 
virtual void onEditorEnable ()
 Called when the editor is activated. More...
 
virtual void onEditorDisable ()
 Called when the editor is deactivated. More...
 
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 *)
 
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 assignDynamicFieldsFrom (SimObject *obj)
 
- Public Member Functions inherited from ConsoleObject
const AbstractClassRep::FieldfindField (StringTableEntry fieldName) const
 Get a reference to a field by name. More...
 
virtual AbstractClassRepgetClassRep () const
 Gets the ClassRep. More...
 
bool setField (const char *fieldName, const char *value)
 Set the value of a field. More...
 
virtual ~ConsoleObject ()
 
const AbstractClassRep::FieldListgetFieldList () const
 Get a list of all the fields. This information cannot be modified. More...
 
AbstractClassRep::FieldListgetModifiableFieldList ()
 
bool & getDynamicGroupExpand ()
 
S32 getClassId (U32 netClassGroup) const
 
const char * getClassName () const
 

Static Public Member Functions

static void initPersistFields ()
 
static LifeMode getParticleAssetLifeModeEnum (const char *label)
 
static const char * getParticleAssetLifeModeDescription (const LifeMode lifeMode)
 
- Static Public Member Functions inherited from AssetBase
static void initPersistFields ()
 Engine. More...
 
- 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. More...
 
static void initPersistFields ()
 
static void consoleInit ()
 
static ConsoleObjectcreate (const char *in_pClassName)
 
static ConsoleObjectcreate (const U32 groupId, const U32 typeId, const U32 in_classId)
 
static AbstractClassRepgetStaticClassRep ()
 Get the abstract class information for this class. More...
 
static AbstractClassRepgetParentStaticClassRep ()
 Get the abstract class information for this class's superclass. More...
 

Protected Member Functions

virtual void initializeAsset (void)
 
void onTamlCustomWrite (TamlCustomNodes &customNodes)
 Called during the writing of the object to allow custom properties to be written. More...
 
void onTamlCustomRead (const TamlCustomNodes &customNodes)
 Called during the reading of the object to allow custom properties to be read. More...
 
- Protected Member Functions inherited from AssetBase
virtual void onAssetRefresh (void)
 
- Protected Member Functions inherited from SimObject
virtual void onTamlPreWrite (void)
 Taml callbacks. More...
 
virtual void onTamlPostWrite (void)
 Called after Taml has finished writing the object. More...
 
virtual void onTamlPreRead (void)
 Called prior to Taml reading the object. More...
 
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. More...
 
void linkNamespaces ()
 
void unlinkNamespaces ()
 
- Protected Member Functions inherited from ConsoleObject
 ConsoleObject ()
 
 ConsoleObject (const ConsoleObject &)
 

Static Protected Member Functions

static bool setLifetime (void *obj, const char *data)
 
static bool writeLifetime (void *obj, StringTableEntry pFieldName)
 
static bool setLifeMode (void *obj, const char *data)
 
static bool writeLifeMode (void *obj, StringTableEntry pFieldName)
 
- Static Protected Member Functions inherited from AssetBase
static bool setAssetName (void *obj, const char *data)
 
static const char * getAssetName (void *obj, const char *data)
 
static bool writeAssetName (void *obj, StringTableEntry pFieldName)
 
static bool setAssetDescription (void *obj, const char *data)
 
static const char * getAssetDescription (void *obj, const char *data)
 
static bool writeAssetDescription (void *obj, StringTableEntry pFieldName)
 
static bool setAssetCategory (void *obj, const char *data)
 
static const char * getAssetCategory (void *obj, const char *data)
 
static bool writeAssetCategory (void *obj, StringTableEntry pFieldName)
 
static bool setAssetAutoUnload (void *obj, const char *data)
 
static const char * getAssetAutoUnload (void *obj, const char *data)
 
static bool writeAssetAutoUnload (void *obj, StringTableEntry pFieldName)
 
static bool setAssetInternal (void *obj, const char *data)
 
static const char * getAssetInternal (void *obj, const char *data)
 
static bool writeAssetInternal (void *obj, StringTableEntry pFieldName)
 
static const char * getAssetPrivate (void *obj, const char *data)
 
- 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 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 SimObject::NotifyallocNotify ()
 Get a free Notify structure. More...
 
static void freeNotify (SimObject::Notify *)
 Mark a Notify structure as free. More...
 
- Static Protected Member Functions inherited from ConsoleObject
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)
 

Additional Inherited Members

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

Member Enumeration Documentation

enum LifeMode

Life Mode.

Enumerator
INVALID_LIFEMODE 
INFINITE 
CYCLE 
STOP 
KILL 

Constructor & Destructor Documentation

Initial value:
{
if( argc == 1 )
{
const char* pFieldValue = argv[0];
AssetPtr<ParticleAsset>* pAssetPtr = dynamic_cast<AssetPtr<ParticleAsset>*>((AssetPtrBase*)(dptr));
if ( pAssetPtr == NULL )
{
Con::warnf( "(TypeParticleAssetPtr) - Failed to set asset Id '%d'.", pFieldValue );
return;
}
pAssetPtr->setAssetId( pFieldValue );
return;
}
Con::warnf( "(TypeParticleAssetPtr) - Cannot set multiple args to a single asset." )
void warnf(ConsoleLogEntry::Type type, const char *fmt,...)
Definition: console.cc:649
Definition: assetPtr.h:42
~ParticleAsset ( )
virtual

Member Function Documentation

bool addEmitter ( ParticleAssetEmitter pParticleAssetEmitter)
virtual void addTamlChild ( SimObject pSimObject)
inlinevirtual

Called when Taml attempts to populate an objects children during a read.

Implements TamlChildren.

void clearEmitters ( void  )
void copyTo ( SimObject object)
virtual

Reimplemented from AssetBase.

ParticleAssetEmitter * createEmitter ( void  )
DECLARE_CONOBJECT ( ParticleAsset  )

Declare Console Object.

ParticleAssetEmitter * findEmitter ( const char *  pEmitterName) const
ParticleAssetField& getAlphaChannelScaleField ( void  )
inline
ParticleAssetEmitter * getEmitter ( const U32  emitterIndex) const
U32 getEmitterCount ( void  ) const
inline
ParticleAssetField& getFixedForceScaleField ( void  )
inline
LifeMode getLifeMode ( void  ) const
inline
F32 getLifetime ( void  ) const
inline
const char * getParticleAssetLifeModeDescription ( const LifeMode  lifeMode)
static
ParticleAsset::LifeMode getParticleAssetLifeModeEnum ( const char *  label)
static
ParticleAssetFieldCollection& getParticleFields ( void  )
inline
ParticleAssetField& getParticleLifeScaleField ( void  )
inline
ParticleAssetField& getQuantityScaleField ( void  )
inline
ParticleAssetField& getRandomMotionScaleField ( void  )
inline
ParticleAssetField& getSizeXScaleField ( void  )
inline
ParticleAssetField& getSizeYScaleField ( void  )
inline
ParticleAssetField& getSpeedScaleField ( void  )
inline
ParticleAssetField& getSpinScaleField ( void  )
inline
virtual SimObject* getTamlChild ( const U32  childIndex) const
inlinevirtual

Called when Taml attempts to compile a list of children.

Implements TamlChildren.

virtual U32 getTamlChildCount ( void  ) const
inlinevirtual

Called when Taml attempts to compile a list of children.

Implements TamlChildren.

void initializeAsset ( void  )
protectedvirtual

Reimplemented from AssetBase.

void initPersistFields ( )
static
bool isAssetValid ( void  ) const
virtual

Reimplemented from AssetBase.

void moveEmitter ( S32  fromIndex,
S32  toIndex 
)
void onDeleteNotify ( SimObject object)
virtual

Called when a SimObject is deleted.

When you are on the notification list for another object and it is deleted, this method is called.

Reimplemented from SimObject.

void onTamlCustomRead ( const TamlCustomNodes customNodes)
protectedvirtual

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

Reimplemented from SimObject.

void onTamlCustomWrite ( TamlCustomNodes customNodes)
protectedvirtual

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

Reimplemented from SimObject.

void removeEmitter ( ParticleAssetEmitter pParticleAssetEmitter,
const bool  deleteEmitter = true 
)
void setLifeMode ( const LifeMode  lifemode)
static bool setLifeMode ( void *  obj,
const char *  data 
)
inlinestaticprotected
void setLifetime ( const F32  lifetime)
static bool setLifetime ( void *  obj,
const char *  data 
)
inlinestaticprotected
static bool writeLifeMode ( void *  obj,
StringTableEntry  pFieldName 
)
inlinestaticprotected
static bool writeLifetime ( void *  obj,
StringTableEntry  pFieldName 
)
inlinestaticprotected

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