ApexEmitterActorParameters Struct Reference

Describes the NxParameterized::Interface for 'ApexEmitterActorParameters' : This class is used for creating NxApexEmitterActor instances. More...

#include <params.h>

List of all members.

Public Attributes
Mat34	initialPose
	'initialPose' : The initial pose where the emitter actor will be put into the scene
F32	initialScale
	'initialScale' : The space scale of the emitter
Mat34	attachRelativePose
	'attachRelativePose' : The emitter will offset this value from the attach actor pose.
Bool	emitAssetParticles
	'emitAssetParticles' : Indicates whether authored asset particle list will be emitted, defaults to true (Used only in case of EmitterGeomExplicit type)
String	overlapTestGroupMaskName
	'overlapTestGroupMaskName' : Overlap Test Collision Group Mask Name
String	overlapTestGroupsMask128Name
	'overlapTestGroupsMask128Name' : Overlap Test 128-bit Collision Groups Mask
F32	emitterDuration
	'emitterDuration' : Emitter duration time (in seconds)

---

Detailed Description

Describes the NxParameterized::Interface for 'ApexEmitterActorParameters' : This class is used for creating NxApexEmitterActor instances.

ApexEmitterActorParameters contains 7 fully qualified names
---------------------------------------------
  1 : Mat34   initialPose                   
  2 : F32     initialScale                  
  3 : Mat34   attachRelativePose            
  4 : Bool    emitAssetParticles            
  5 : String  overlapTestGroupMaskName      
  6 : String  overlapTestGroupsMask128Name  
  7 : F32     emitterDuration               

---

Member Data Documentation

Mat34 ApexEmitterActorParameters::attachRelativePose

'attachRelativePose' : The emitter will offset this value from the attach actor pose.

Bool ApexEmitterActorParameters::emitAssetParticles

'emitAssetParticles' : Indicates whether authored asset particle list will be emitted, defaults to true (Used only in case of EmitterGeomExplicit type)

In case this emitter has EmitterGeomExplicit geometry type, it can store a particle list in its asset and also in its actor instance. So if this parameter equals to true, then both particle lists from asset and actor instance will be emitted. And if this paramater equals to false, then only particle list from actor instance will be emitterd.

F32 ApexEmitterActorParameters::emitterDuration

'emitterDuration' : Emitter duration time (in seconds)

Specifies a duration (in seconds) that the emitter will emit for after being enabled. After the specified duration, the emitter will turn off, unless it has already been explicitly turned off via an API call. The special value 0.0f means there is no duration, and the emitter will remain on until explicitly turned off.

Mat34 ApexEmitterActorParameters::initialPose

'initialPose' : The initial pose where the emitter actor will be put into the scene

F32 ApexEmitterActorParameters::initialScale

'initialScale' : The space scale of the emitter

String ApexEmitterActorParameters::overlapTestGroupMaskName

'overlapTestGroupMaskName' : Overlap Test Collision Group Mask Name

This name resolves to a 32-bit bitmask of collision groups for overlap tests when particles are spawned. It is resolved by a call to the named resource provider using the 'NSCollisionGroupMask' namespace. If none is provided, the raycast will hit everything in the scene. This avoids storing fragile enums in asset files.

String ApexEmitterActorParameters::overlapTestGroupsMask128Name

'overlapTestGroupsMask128Name' : Overlap Test 128-bit Collision Groups Mask

This name resolves to a 128-bit NxGroupsMask used for overlap tests when particles are spawned. It is resolved by a call to the named resource provider using the 'NSCollisionGroup128'

---

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

• params.h