cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
PUMeshSurfaceEmitter Class Reference

The MeshSurfaceEmitter is a ParticleEmitter that emits particles on the surface of a mesh. More...

#include <CCPUMeshSurfaceEmitter.h>

Inheritance diagram for PUMeshSurfaceEmitter:
PUEmitter Particle3DEmitter Ref

Public Member Functions

const std::string & getMeshName (void) const
 Returns the mesh name. More...
 
var getMeshName ()
 Returns the mesh name. More...
 
local getMeshName ()
 Returns the mesh name. More...
 
void setMeshName (const std::string &meshName, bool doBuild=true)
 Sets the mesh name. More...
 
bool useNormals (void) const
 Returns true if normals are used for the particle direction. More...
 
void setUseNormals (bool useNormals)
 Set indication whether normals are used for the particle direction. More...
 
const
MeshInfo::MeshSurfaceDistribution 
getDistribution (void) const
 Returns the type op distribution. More...
 
local getDistribution ()
 Returns the type op distribution. More...
 
void setDistribution (MeshInfo::MeshSurfaceDistribution distribution)
 Set the type of particle distribution on the surface of a mesh. More...
 
const Vec3getScale (void) const
 Returns the scale of the mesh. More...
 
void setScale (const Vec3 &scale)
 Set the scale of the mesh. More...
 
void build (void)
 Build all the data needed to generate the particles. More...
 
virtual void prepare () override
 Build the data if the mesh name has been set. More...
 
virtual void unPrepare () override
 Reverse it. More...
 
virtual void initParticlePosition (PUParticle3D *particle) override
 Determine a particle position on the mesh surface. More...
 
var initParticlePosition ( var particle)
 Determine a particle position on the mesh surface. More...
 
local initParticlePosition ( local particle)
 Determine a particle position on the mesh surface. More...
 
virtual unsigned short calculateRequestedParticles (float timeElapsed) override
 See ParticleEmitter. More...
 
local calculateRequestedParticles ( local timeElapsed)
 See ParticleEmitter. More...
 
virtual void initParticleDirection (PUParticle3D *particle) override
 Determine the particle direction. More...
 
virtual PUMeshSurfaceEmitterclone () override
local clone ()
virtual void copyAttributesTo (PUEmitter *emitter) override
local copyAttributesTo ( local emitter)
virtual ~PUMeshSurfaceEmitter (void)
- Public Member Functions inherited from PUEmitter
 PUEmitter ()
virtual ~PUEmitter ()
virtual void notifyStart ()
virtual void notifyStop ()
virtual void notifyPause ()
virtual void notifyResume ()
virtual void notifyRescaled (const Vec3 &scale)
local notifyRescaled ( local scale)
virtual void preUpdateEmitter (float deltaTime)
local preUpdateEmitter ( local deltaTime)
virtual void updateEmitter (Particle3D *particle, float deltaTime) override
var updateEmitter ( var particle, var deltaTime)
local updateEmitter ( local particle, local deltaTime)
virtual void postUpdateEmitter (float deltaTime)
local postUpdateEmitter ( local deltaTime)
virtual void emit (int count) override
var emit ( var count)
local emit ( local count)
void setLocalPosition (const Vec3 &pos)
const Vec3 getLocalPosition () const
const Vec3getDerivedPosition ()
 Calculate the derived position of the affector. More...
 
var getDerivedPosition ()
 Calculate the derived position of the affector. More...
 
local getDerivedPosition ()
 Calculate the derived position of the affector. More...
 
void setEnabled (bool enabled)
 Enables or disables the emitter. More...
 
bool isEnabled (void) const
bool isEmitterDone () const
const std::string & getEmitterType (void) const
 Todo. More...
 
local getEmitterType ()
 Todo. More...
 
void setEmitterType (const std::string &emitterType)
const std::string & getName (void) const
 Todo. More...
 
local getName ()
 Todo. More...
 
void setName (const std::string &name)
PUDynamicAttributegetDynAngle (void) const
 Todo. More...
 
local getDynAngle ()
 Todo. More...
 
void setDynAngle (PUDynamicAttribute *dynAngle)
PUDynamicAttributegetDynEmissionRate (void) const
 Todo. More...
 
void setDynEmissionRate (PUDynamicAttribute *dynEmissionRate)
PUDynamicAttributegetDynTotalTimeToLive (void) const
 Todo. More...
 
local getDynTotalTimeToLive ()
 Todo. More...
 
void setDynTotalTimeToLive (PUDynamicAttribute *dynTotalTimeToLive)
PUDynamicAttributegetDynParticleMass (void) const
 Todo. More...
 
local getDynParticleMass ()
 Todo. More...
 
void setDynParticleMass (PUDynamicAttribute *dynParticleMass)
PUDynamicAttributegetDynVelocity (void) const
 Todo. More...
 
void setDynVelocity (PUDynamicAttribute *dynVelocity)
PUDynamicAttributegetDynDuration (void) const
 Todo. More...
 
void setDynDuration (PUDynamicAttribute *dynDuration)
void setDynDurationSet (bool durationSet)
PUDynamicAttributegetDynRepeatDelay (void) const
 Todo. More...
 
void setDynRepeatDelay (PUDynamicAttribute *dynRepeatDelay)
void setDynRepeatDelaySet (bool repeatDelaySet)
PUDynamicAttributegetDynParticleAllDimensions (void) const
 Todo. More...
 
void setDynParticleAllDimensions (PUDynamicAttribute *dynParticleAllDimensions)
void setDynParticleAllDimensionsSet (bool particleAllDimensionsSet)
PUDynamicAttributegetDynParticleWidth (void) const
 Todo. More...
 
void setDynParticleWidth (PUDynamicAttribute *dynParticleWidth)
void setDynParticleWidthSet (bool particleWidthSet)
PUDynamicAttributegetDynParticleHeight (void) const
 Todo. More...
 
void setDynParticleHeight (PUDynamicAttribute *dynParticleHeight)
void setDynParticleHeightSet (bool particleHeightSet)
PUDynamicAttributegetDynParticleDepth (void) const
 Todo. More...
 
void setDynParticleDepth (PUDynamicAttribute *dynParticleDepth)
void setDynParticleDepthSet (bool particleDepthSet)
const std::string & getEmitsName (void) const
 Todo. More...
 
void setEmitsName (const std::string &emitsName)
PUParticle3D::ParticleType getEmitsType () const
local getEmitsType ()
void setEmitsType (PUParticle3D::ParticleType type)
RefgetEmitsEntityPtr () const
bool isMarkedForEmission () const
void setMarkedForEmission (bool isMarked)
const Vec3getParticleDirection (void)
 Returns the base direction of the particle that is going to be emitted. More...
 
const Vec3getOriginalParticleDirection (void) const
 Returns the originally set particle direction. More...
 
local getOriginalParticleDirection ()
 Returns the originally set particle direction. More...
 
const QuaterniongetParticleOrientation (void) const
 Returns the base orientation of the particle that is going to be emitted. More...
 
void setParticleOrientation (const Quaternion &orientation)
 Set the orientation of the particle. More...
 
const QuaterniongetParticleOrientationRangeStart (void) const
 Returns the start orientation of the particle that is going to be emitted. More...
 
void setParticleOrientationRangeStart (const Quaternion &orientationRangeStart)
 Set start orientation of the particle that is going to be emitted. More...
 
const QuaterniongetParticleOrientationRangeEnd (void) const
 Returns the end orientation of the particle that is going to be emitted. More...
 
void setParticleOrientationRangeEnd (const Quaternion &orientationRangeEnd)
 Set end orientation of the particle that is going to be emitted. More...
 
void setParticleDirection (const Vec3 &direction)
 Sets the direction of the particle that the emitter is emitting. More...
 
bool isAutoDirection (void) const
 Todo. More...
 
void setAutoDirection (bool autoDirection)
 Todo. More...
 
var setAutoDirection ( var autoDirection)
 Todo. More...
 
local setAutoDirection ( local autoDirection)
 Todo. More...
 
bool isForceEmission (void) const
 Todo. More...
 
void setForceEmission (bool forceEmission)
 Todo. More...
 
var setForceEmission ( var forceEmission)
 Todo. More...
 
local setForceEmission ( local forceEmission)
 Todo. More...
 
const Vec4getParticleColor (void) const
 Get the colour of a particle that will be emitted. More...
 
var getParticleColor ()
 Get the colour of a particle that will be emitted. More...
 
local getParticleColor ()
 Get the colour of a particle that will be emitted. More...
 
void setParticleColor (const Vec4 &particleColour)
 Set the colour of an emitted particle. More...
 
const Vec4getParticleColorRangeStart (void) const
 Get the colour range start of an emitted particle. More...
 
var getParticleColorRangeStart ()
 Get the colour range start of an emitted particle. More...
 
local getParticleColorRangeStart ()
 Get the colour range start of an emitted particle. More...
 
void setParticleColorRangeStart (const Vec4 &particleColourRangeStart)
 Set the colour range start of an emitted particle. More...
 
const Vec4getParticleColorRangeEnd (void) const
 Get the colour range end of an emitted particle. More...
 
void setParticleColorRangeEnd (const Vec4 &particleColourRangeEnd)
 Set the colour range end of an emitted particle. More...
 
const unsigned short & getParticleTextureCoords (void) const
 Get the texture coords of an emitted particle. More...
 
void setParticleTextureCoords (const unsigned short &particleTextureCoords)
 Set the texture coords of an emitted particle. More...
 
const unsigned short & getParticleTextureCoordsRangeStart (void) const
 Get the texture coords range start of an emitted particle. More...
 
local getParticleTextureCoordsRangeStart ()
 Get the texture coords range start of an emitted particle. More...
 
void setParticleTextureCoordsRangeStart (const unsigned short &particleTextureCoordsRangeStart)
 Set the texture coords range start of an emitted particle. More...
 
var setParticleTextureCoordsRangeStart ( var particleTextureCoordsRangeStart)
 Set the texture coords range start of an emitted particle. More...
 
local setParticleTextureCoordsRangeStart ( local particleTextureCoordsRangeStart)
 Set the texture coords range start of an emitted particle. More...
 
const unsigned short & getParticleTextureCoordsRangeEnd (void) const
 Get the texture coords range end of an emitted particle. More...
 
void setParticleTextureCoordsRangeEnd (const unsigned short &particleTextureCoordsRangeEnd)
 Set the texture coords range end of an emitted particle. More...
 
var setParticleTextureCoordsRangeEnd ( var particleTextureCoordsRangeEnd)
 Set the texture coords range end of an emitted particle. More...
 
local setParticleTextureCoordsRangeEnd ( local particleTextureCoordsRangeEnd)
 Set the texture coords range end of an emitted particle. More...
 
bool isKeepLocal (void) const
 Todo. More...
 
void setKeepLocal (bool keepLocal)
 If this attribute is set to 'true', the particles are emitted relative to the emitter. More...
 
bool makeParticleLocal (PUParticle3D *particle)
 Transforms the particle position in a local position relative to the emitter. More...
 
- Public Member Functions inherited from Particle3DEmitter
void setEnabled (bool enabled)
 Enables or disables the emitter. More...
 
bool isEnabled (void) const
virtual ~Particle3DEmitter ()
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 

Static Public Member Functions

static PUMeshSurfaceEmittercreate ()
local create ()

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: PUMeshSurfaceEmitter(void)
var __pad0__: PUMeshSurfaceEmitter(void)
local __pad0__: PUMeshSurfaceEmitter(void)
- Public Attributes inherited from Particle3DEmitter
CC_CONSTRUCTOR_ACCESS __pad0__: Particle3DEmitter()
var __pad0__: Particle3DEmitter()
local __pad0__: Particle3DEmitter()

Static Public Attributes

static const Vec3 DEFAULT_SCALE
var DEFAULT_SCALE
local DEFAULT_SCALE
static const
MeshInfo::MeshSurfaceDistribution 
DEFAULT_DISTRIBUTION
- Static Public Attributes inherited from PUEmitter
static const bool DEFAULT_ENABLED
var DEFAULT_ENABLED
local DEFAULT_ENABLED
static const Vec3 DEFAULT_POSITION
var DEFAULT_POSITION
local DEFAULT_POSITION
static const bool DEFAULT_KEEP_LOCAL
var DEFAULT_KEEP_LOCAL
local DEFAULT_KEEP_LOCAL
static const Vec3 DEFAULT_DIRECTION
var DEFAULT_DIRECTION
local DEFAULT_DIRECTION
static const Quaternion DEFAULT_ORIENTATION
var DEFAULT_ORIENTATION
local DEFAULT_ORIENTATION
static const Quaternion DEFAULT_ORIENTATION_RANGE_START
var DEFAULT_ORIENTATION_RANGE_START
local DEFAULT_ORIENTATION_RANGE_START
static const Quaternion DEFAULT_ORIENTATION_RANGE_END
var DEFAULT_ORIENTATION_RANGE_END
local DEFAULT_ORIENTATION_RANGE_END
static const unsigned short DEFAULT_START_TEXTURE_COORDS
var DEFAULT_START_TEXTURE_COORDS
local DEFAULT_START_TEXTURE_COORDS
static const unsigned short DEFAULT_END_TEXTURE_COORDS
static const unsigned short DEFAULT_TEXTURE_COORDS
var DEFAULT_TEXTURE_COORDS
local DEFAULT_TEXTURE_COORDS
static const Vec4 DEFAULT_START_COLOUR_RANGE
var DEFAULT_START_COLOUR_RANGE
local DEFAULT_START_COLOUR_RANGE
static const Vec4 DEFAULT_END_COLOUR_RANGE
var DEFAULT_END_COLOUR_RANGE
local DEFAULT_END_COLOUR_RANGE
static const Vec4 DEFAULT_COLOUR
static const bool DEFAULT_AUTO_DIRECTION
static const bool DEFAULT_FORCE_EMISSION
var DEFAULT_FORCE_EMISSION
local DEFAULT_FORCE_EMISSION
static const float DEFAULT_EMISSION_RATE
var DEFAULT_EMISSION_RATE
local DEFAULT_EMISSION_RATE
static const float DEFAULT_TIME_TO_LIVE
var DEFAULT_TIME_TO_LIVE
local DEFAULT_TIME_TO_LIVE
static const float DEFAULT_MASS
static const float DEFAULT_VELOCITY
static const float DEFAULT_DURATION
var DEFAULT_DURATION
local DEFAULT_DURATION
static const float DEFAULT_REPEAT_DELAY
var DEFAULT_REPEAT_DELAY
local DEFAULT_REPEAT_DELAY
static const float DEFAULT_ANGLE
static const float DEFAULT_DIMENSIONS
var DEFAULT_DIMENSIONS
local DEFAULT_DIMENSIONS
static const float DEFAULT_WIDTH
local DEFAULT_WIDTH
static const float DEFAULT_HEIGHT
static const float DEFAULT_DEPTH
var DEFAULT_DEPTH
local DEFAULT_DEPTH

Protected Attributes

std::string _meshName
Quaternion _orientation
Vec3 _scale
var _scale
local _scale
MeshInfo::MeshSurfaceDistribution _distribution
var _distribution
local _distribution
MeshInfo_meshInfo
size_t _triangleIndex
bool _directionSet
- Protected Attributes inherited from PUEmitter
Vec3 _position
Vec3 _latestPosition
Vec3 _latestPositionDiff
Vec3 _derivedPosition
Vec3 _emitterScale
 Although the scale is on a Particle System level, the emitter can also be scaled. More...
 
std::string _emitterType
std::string _name
Vec3 _particleDirection
 Direction (and speed) of the emitted particle. More...
 
var _particleDirection
 Direction (and speed) of the emitted particle. More...
 
local _particleDirection
 Direction (and speed) of the emitted particle. More...
 
Vec3 _originalParticleDirection
 The original direction of the emitted particle. More...
 
Quaternion _particleOrientation
 Orientation of the particle as soon as it is emitted. More...
 
Quaternion _particleOrientationRangeStart
 If set, the range generates a random orientation between start and end. More...
 
Quaternion _particleOrientationRangeEnd
bool _particleOrientationRangeSet
PUDynamicAttribute_dynAngle
PUDynamicAttribute_dynEmissionRate
std::string _emitsName
PUDynamicAttribute_dynTotalTimeToLive
 Dynamic attribute used to generate the total time to live. More...
 
var _dynTotalTimeToLive
 Dynamic attribute used to generate the total time to live. More...
 
local _dynTotalTimeToLive
 Dynamic attribute used to generate the total time to live. More...
 
PUDynamicAttribute_dynParticleMass
 Dynamic attribute used to generate the mass of a particle. More...
 
var _dynParticleMass
 Dynamic attribute used to generate the mass of a particle. More...
 
local _dynParticleMass
 Dynamic attribute used to generate the mass of a particle. More...
 
PUDynamicAttribute_dynVelocity
 Dynamic attribute used to generate the velocity of a particle. More...
 
PUDynamicAttribute_dynDuration
 Dynamic attribute used to define the duration of the emitter. More...
 
var _dynDuration
 Dynamic attribute used to define the duration of the emitter. More...
 
local _dynDuration
 Dynamic attribute used to define the duration of the emitter. More...
 
PUDynamicAttribute_dynRepeatDelay
 Dynamic attribute used to define the repeat/delay of the emitter. More...
 
PUDynamicAttribute_dynParticleAllDimensions
 Dynamic attribute used to define the (own) dimensions of a particle. More...
 
var _dynParticleAllDimensions
 Dynamic attribute used to define the (own) dimensions of a particle. More...
 
local _dynParticleAllDimensions
 Dynamic attribute used to define the (own) dimensions of a particle. More...
 
bool _dynParticleAllDimensionsSet
PUDynamicAttribute_dynParticleWidth
 Dynamic attribute used to define the (own) width of a particle. More...
 
bool _dynParticleWidthSet
PUDynamicAttribute_dynParticleHeight
 Dynamic attribute used to define the (own) height of a particle. More...
 
bool _dynParticleHeightSet
PUDynamicAttribute_dynParticleDepth
 Dynamic attribute used to define the (own) depth of a particle. More...
 
bool _dynParticleDepthSet
Vec3 _upVector
 Notional up vector, just used to speed up generation of variant directions. More...
 
float _remainder
 Particles that are left to be emitted from the previous time. More...
 
PUDynamicAttributeHelper _dynamicAttributeHelper
 Helper factory. More...
 
var _dynamicAttributeHelper
 Helper factory. More...
 
float _durationRemain
 Duration remainder. More...
 
bool _dynDurationSet
 Indication to determine whether duration is set. More...
 
float _repeatDelayRemain
 Repeat/delay remainder. More...
 
bool _dynRepeatDelaySet
 Indication to determine whether repeat/delay is set. More...
 
bool _autoDirection
 Auto direction means that the direction of a particle is not determined by the direction vector that has been set, but the direction vector is generated based on the shape of the emitter. More...
 
bool _forceEmission
 In normal cases, emission is regulated by time. More...
 
bool _originalForceEmission
 Original value, used to set it back. More...
 
bool _forceEmissionExecuted
 If mForceEmission has been set to true and if all particles are emitted, the mForceEmissionExecuted is also set to true, preventing any further 'forced emission'. More...
 
bool _originalForceEmissionExecuted
 Original value, used to set it back. More...
 
Vec4 _particleColor
 Colour that is assigned to an emitted particle. More...
 
Vec4 _particleColorRangeStart
 Used to randomize the colour of an emitted particle. More...
 
Vec4 _particleColorRangeEnd
 Used to randomize the colour of an emitted particle. More...
 
bool _particleColorRangeSet
 Used to determine whether the colour range has been set. More...
 
bool _keepLocal
 Determines whether particle positions should be kept local in relation to the emitter. More...
 
unsigned short _particleTextureCoords
 Texture coords that is assigned to an emitted particle (only works if the renderer uses it) More...
 
var _particleTextureCoords
 Texture coords that is assigned to an emitted particle (only works if the renderer uses it) More...
 
local _particleTextureCoords
 Texture coords that is assigned to an emitted particle (only works if the renderer uses it) More...
 
unsigned short _particleTextureCoordsRangeStart
 Used to randomize the texture coords of an emitted particle. More...
 
unsigned short _particleTextureCoordsRangeEnd
 Used to randomize the texture coords of an emitted particle. More...
 
bool _particleTextureCoordsRangeSet
 Used to determine whether the texture coords range has been set. More...
 
bool _originEnabled
bool _originEnabledSet
PUParticle3D::ParticleType _emitsType
var _emitsType
local _emitsType
Ref_emitsEntity
bool _isMarkedForEmission
- Protected Attributes inherited from Particle3DEmitter
ParticleSystem3D_particleSystem
int _emitRate
bool _isEnabled
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Additional Inherited Members

- Protected Member Functions inherited from PUEmitter
virtual void initParticleOrientation (PUParticle3D *particle)
 Internal method for generating the particle orientation. More...
 
var initParticleOrientation ( var particle)
 Internal method for generating the particle orientation. More...
 
local initParticleOrientation ( local particle)
 Internal method for generating the particle orientation. More...
 
virtual void initParticleVelocity (PUParticle3D *particle)
virtual void initParticleMass (PUParticle3D *particle)
var initParticleMass ( var particle)
local initParticleMass ( local particle)
virtual void initParticleColor (PUParticle3D *particle)
virtual void initParticleTextureCoords (PUParticle3D *particle)
virtual float initParticleTimeToLive ()
virtual void initParticleDimensions (PUParticle3D *particle)
local initParticleDimensions ( local particle)
virtual void initParticleForEmission (PUParticle3D *particle)
var initParticleForEmission ( var particle)
local initParticleForEmission ( local particle)
void initTimeBased (void)
 Initialise some attributes that are time-based. More...
 
void generateAngle (float &angle)
 Internal method for generating the angle. More...
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Detailed Description

The MeshSurfaceEmitter is a ParticleEmitter that emits particles on the surface of a mesh.

Remarks
There are several ways of emitting it on the surface, from the vertices, edges and faces of a mesh. It is also possible to define whether more particles emit on larger faces.

Constructor & Destructor Documentation

virtual ~PUMeshSurfaceEmitter ( void  )
virtual
var ~PUMeshSurfaceEmitter (   )
virtual
local ~PUMeshSurfaceEmitter (   )
virtual

Member Function Documentation

void build ( void  )

Build all the data needed to generate the particles.

var build (   )

Build all the data needed to generate the particles.

local build (   )

Build all the data needed to generate the particles.

virtual unsigned short
calculateRequestedParticles
( float  timeElapsed)
overridevirtual

See ParticleEmitter.

Reimplemented from PUEmitter.

var calculateRequestedParticles ( var  timeElapsed)
overridevirtual

See ParticleEmitter.

Reimplemented from PUEmitter.

local calculateRequestedParticles ( local  timeElapsed)
overridevirtual

See ParticleEmitter.

Reimplemented from PUEmitter.

virtual PUMeshSurfaceEmitter* clone ( )
overridevirtual

Implements PUEmitter.

var clone ( )
overridevirtual

Implements PUEmitter.

local clone ( )
overridevirtual

Implements PUEmitter.

virtual void copyAttributesTo ( PUEmitter emitter)
overridevirtual

Reimplemented from PUEmitter.

var copyAttributesTo ( var  emitter)
overridevirtual

Reimplemented from PUEmitter.

local copyAttributesTo ( local  emitter)
overridevirtual

Reimplemented from PUEmitter.

static PUMeshSurfaceEmitter* create ( )
static
var create ( )
static
local create ( )
static
const
MeshInfo::MeshSurfaceDistribution
getDistribution
( void  ) const

Returns the type op distribution.

Remarks
There are several ways to emit particles on the surface of a mesh. This attribute indicates the type of distrubution on the surface.
var getDistribution (   )

Returns the type op distribution.

Remarks
There are several ways to emit particles on the surface of a mesh. This attribute indicates the type of distrubution on the surface.
local getDistribution (   )

Returns the type op distribution.

Remarks
There are several ways to emit particles on the surface of a mesh. This attribute indicates the type of distrubution on the surface.
const std::string& getMeshName ( void  ) const

Returns the mesh name.

var getMeshName (   )

Returns the mesh name.

local getMeshName (   )

Returns the mesh name.

const Vec3& getScale ( void  ) const

Returns the scale of the mesh.

var getScale (   )

Returns the scale of the mesh.

local getScale (   )

Returns the scale of the mesh.

virtual void initParticleDirection ( PUParticle3D particle)
overridevirtual

Determine the particle direction.

Reimplemented from PUEmitter.

var initParticleDirection ( var  particle)
overridevirtual

Determine the particle direction.

Reimplemented from PUEmitter.

local initParticleDirection ( local  particle)
overridevirtual

Determine the particle direction.

Reimplemented from PUEmitter.

virtual void initParticlePosition ( PUParticle3D particle)
overridevirtual

Determine a particle position on the mesh surface.

Reimplemented from PUEmitter.

var initParticlePosition ( var  particle)
overridevirtual

Determine a particle position on the mesh surface.

Reimplemented from PUEmitter.

local initParticlePosition ( local  particle)
overridevirtual

Determine a particle position on the mesh surface.

Reimplemented from PUEmitter.

virtual void prepare ( )
overridevirtual

Build the data if the mesh name has been set.

Reimplemented from PUEmitter.

var prepare ( )
overridevirtual

Build the data if the mesh name has been set.

Reimplemented from PUEmitter.

local prepare ( )
overridevirtual

Build the data if the mesh name has been set.

Reimplemented from PUEmitter.

void setDistribution ( MeshInfo::MeshSurfaceDistribution  distribution)

Set the type of particle distribution on the surface of a mesh.

var setDistribution ( var  distribution)

Set the type of particle distribution on the surface of a mesh.

local setDistribution ( local  distribution)

Set the type of particle distribution on the surface of a mesh.

void setMeshName ( const std::string &  meshName,
bool  doBuild = true 
)

Sets the mesh name.

var setMeshName ( var  meshName,
var  doBuild = true 
)

Sets the mesh name.

local setMeshName ( local  meshName,
local  doBuild = true 
)

Sets the mesh name.

void setScale ( const Vec3 scale)

Set the scale of the mesh.

Remarks
This options makes it possible to scale the mesh independently from the particle system scale as a whole.
var setScale ( var  scale)

Set the scale of the mesh.

Remarks
This options makes it possible to scale the mesh independently from the particle system scale as a whole.
local setScale ( local  scale)

Set the scale of the mesh.

Remarks
This options makes it possible to scale the mesh independently from the particle system scale as a whole.
void setUseNormals ( bool  useNormals)

Set indication whether normals are used for the particle direction.

var setUseNormals ( var  useNormals)

Set indication whether normals are used for the particle direction.

local setUseNormals ( local  useNormals)

Set indication whether normals are used for the particle direction.

virtual void unPrepare ( )
overridevirtual

Reverse it.

Reimplemented from PUEmitter.

var unPrepare ( )
overridevirtual

Reverse it.

Reimplemented from PUEmitter.

local unPrepare ( )
overridevirtual

Reverse it.

Reimplemented from PUEmitter.

bool useNormals ( void  ) const

Returns true if normals are used for the particle direction.

var useNormals (   )

Returns true if normals are used for the particle direction.

local useNormals (   )

Returns true if normals are used for the particle direction.

Member Data Documentation

var __pad0__
local __pad0__
bool _directionSet
protected
var _directionSet
protected
local _directionSet
protected
MeshInfo::MeshSurfaceDistribution
_distribution
protected
var _distribution
protected
local _distribution
protected
MeshInfo* _meshInfo
protected
var _meshInfo
protected
local _meshInfo
protected
std::string _meshName
protected
var _meshName
protected
local _meshName
protected
Quaternion _orientation
protected
var _orientation
protected
local _orientation
protected
Vec3 _scale
protected
var _scale
protected
local _scale
protected
size_t _triangleIndex
protected
var _triangleIndex
protected
local _triangleIndex
protected
const
MeshInfo::MeshSurfaceDistribution
DEFAULT_DISTRIBUTION
static
var DEFAULT_DISTRIBUTION
static
local DEFAULT_DISTRIBUTION
static
const Vec3 DEFAULT_SCALE
static
var DEFAULT_SCALE
static
local DEFAULT_SCALE
static

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