MeiCam SDK For Android  3.14.4
Classes | Public Member Functions | List of all members
com.meicam.sdk.NvsAssetPackageParticleDescParser Class Reference

Particle effect package parsing class. More...

Classes

class  NvsParticleEmitterDesc
 Particle emitter description class.Contain the particle emitter's position and a list of its child particle emitters' names. More...
 

Public Member Functions

 NvsAssetPackageParticleDescParser (String fxDescription)
 The constructor of NvsAssetPackageParticleDescParser class. More...
 
int GetParticleType ()
 Get particle type. More...
 
int GetLeftEyePlace ()
 Get the position type of the particle emitter at the left eye.Please refer to Particle position type. More...
 
List< String > GetLeftEyeEmitter ()
 Get a list of the particle emitter names at the left eye. More...
 
int GetRightEyePlace ()
 Get the position type of the particle emitter at the right eye.Please refer to Particle position type. More...
 
List< String > GetRightEyeEmitter ()
 Get a list of the particle emitter names at the right eye. More...
 
int GetParticlePartitionCount ()
 Get the count of particle partition. More...
 
int GetParticlePartitionPlace (int partitionIndex)
 Get the position type of the particle emitter partition with the specified index value. More...
 
List< String > GetParticlePartitionEmitter (int partitionIndex)
 Get the name list of the particle emitter partition with the specified index value. More...
 

Static Public Attributes

Particle type

static final int PARTICLE_TYPE_NORMAL = 0
 Particle effect without interaction. More...
 
static final int PARTICLE_TYPE_TOUCH = 1
 Particle effect controlled by touch screen. More...
 
static final int PARTICLE_TYPE_GESTURE = 2
 Particle effect controlled by gesture. More...
 
static final int PARTICLE_TYPE_EYE = 3
 Particle effect controlled by eye. More...
 
static final int PARTICLE_TYPE_MOUTH = 4
 Particle effect controlled by mouth. More...
 
the particle emitter position type

static final int EMITTER_PLACE_LEFT = 0
 The particle emitter is on the left side of the current part. More...
 
static final int EMITTER_PLACE_RIGHT = 1
 The particle emitter is on the right side of the current part. More...
 
static final int EMITTER_PLACE_TOP = 2
 The particle emitter is above the current part. More...
 
static final int EMITTER_PLACE_BOTTOM = 3
 The particle emitter is below the current part. More...
 
static final int EMITTER_PLACE_CENTER = 4
 The particle emitter is in the middle of the current part. More...
 

Detailed Description

Particle effect package parsing class.

Warning
In the NvsAssetPackageParticleDescParser class, all public APIs are used in the UI thread! ! !

Constructor & Destructor Documentation

◆ NvsAssetPackageParticleDescParser()

com.meicam.sdk.NvsAssetPackageParticleDescParser.NvsAssetPackageParticleDescParser ( String  fxDescription)
inline

The constructor of NvsAssetPackageParticleDescParser class.

Parameters
fxDescriptionParticle effect description string.

Member Function Documentation

◆ GetLeftEyeEmitter()

List<String> com.meicam.sdk.NvsAssetPackageParticleDescParser.GetLeftEyeEmitter ( )
inline

Get a list of the particle emitter names at the left eye.

Returns
Return a list of the particle emitter names

◆ GetLeftEyePlace()

int com.meicam.sdk.NvsAssetPackageParticleDescParser.GetLeftEyePlace ( )
inline

Get the position type of the particle emitter at the left eye.Please refer to Particle position type.

Returns
Return the position type.

◆ GetParticlePartitionCount()

int com.meicam.sdk.NvsAssetPackageParticleDescParser.GetParticlePartitionCount ( )
inline

Get the count of particle partition.

Returns
Return the count of partition

◆ GetParticlePartitionEmitter()

List<String> com.meicam.sdk.NvsAssetPackageParticleDescParser.GetParticlePartitionEmitter ( int  partitionIndex)
inline

Get the name list of the particle emitter partition with the specified index value.

Parameters
partitionIndexpartition index
Returns
Return a list of a partition particle emitter name

◆ GetParticlePartitionPlace()

int com.meicam.sdk.NvsAssetPackageParticleDescParser.GetParticlePartitionPlace ( int  partitionIndex)
inline

Get the position type of the particle emitter partition with the specified index value.

Parameters
partitionIndexpartition index
Returns
Return the position type

◆ GetParticleType()

int com.meicam.sdk.NvsAssetPackageParticleDescParser.GetParticleType ( )
inline

Get particle type.

Returns
Return the particle type.Please refer to Particle type.

◆ GetRightEyeEmitter()

List<String> com.meicam.sdk.NvsAssetPackageParticleDescParser.GetRightEyeEmitter ( )
inline

Get a list of the particle emitter names at the right eye.

Returns
Return a list of the particle emitter names

◆ GetRightEyePlace()

int com.meicam.sdk.NvsAssetPackageParticleDescParser.GetRightEyePlace ( )
inline

Get the position type of the particle emitter at the right eye.Please refer to Particle position type.

Returns
Return the position type.

Member Data Documentation

◆ EMITTER_PLACE_BOTTOM

final int com.meicam.sdk.NvsAssetPackageParticleDescParser.EMITTER_PLACE_BOTTOM = 3
static

The particle emitter is below the current part.

◆ EMITTER_PLACE_CENTER

final int com.meicam.sdk.NvsAssetPackageParticleDescParser.EMITTER_PLACE_CENTER = 4
static

The particle emitter is in the middle of the current part.

◆ EMITTER_PLACE_LEFT

final int com.meicam.sdk.NvsAssetPackageParticleDescParser.EMITTER_PLACE_LEFT = 0
static

The particle emitter is on the left side of the current part.

◆ EMITTER_PLACE_RIGHT

final int com.meicam.sdk.NvsAssetPackageParticleDescParser.EMITTER_PLACE_RIGHT = 1
static

The particle emitter is on the right side of the current part.

◆ EMITTER_PLACE_TOP

final int com.meicam.sdk.NvsAssetPackageParticleDescParser.EMITTER_PLACE_TOP = 2
static

The particle emitter is above the current part.

◆ PARTICLE_TYPE_EYE

final int com.meicam.sdk.NvsAssetPackageParticleDescParser.PARTICLE_TYPE_EYE = 3
static

Particle effect controlled by eye.

◆ PARTICLE_TYPE_GESTURE

final int com.meicam.sdk.NvsAssetPackageParticleDescParser.PARTICLE_TYPE_GESTURE = 2
static

Particle effect controlled by gesture.

◆ PARTICLE_TYPE_MOUTH

final int com.meicam.sdk.NvsAssetPackageParticleDescParser.PARTICLE_TYPE_MOUTH = 4
static

Particle effect controlled by mouth.

◆ PARTICLE_TYPE_NORMAL

final int com.meicam.sdk.NvsAssetPackageParticleDescParser.PARTICLE_TYPE_NORMAL = 0
static

Particle effect without interaction.

◆ PARTICLE_TYPE_TOUCH

final int com.meicam.sdk.NvsAssetPackageParticleDescParser.PARTICLE_TYPE_TOUCH = 1
static

Particle effect controlled by touch screen.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17