Top Description Inners Fields Constructors Methods

com.badlogic.gdx.graphics.g3d.particles.influencers

public abstract Class RegionInfluencer

Class Inheritance

java.lang.Object
com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent
com.badlogic.gdx.graphics.g3d.particles.influencers.Influencer
com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer

Known Direct Subclasses

com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer.Single, com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer.Random, com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer.Animated

Imports

com.badlogic.gdx.assets.AssetManager, com.badlogic.gdx.graphics.Texture, com.badlogic.gdx.graphics.g2d.TextureAtlas, .TextureRegion, com.badlogic.gdx.graphics.g3d.particles.ParallelArray.FloatChannel, .ParticleChannels, .ResourceData, .ResourceData.SaveData, com.badlogic.gdx.utils.Array, .Json, .JsonValue

It's an Influencer which assigns a region of a Texture to the particles.

Author: Inferno

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	RegionInfluencer.Animated Assigns a region to the particles using the particle life percent to calculate the current index in the `RegionInfluencer#regions` array.
public static class	RegionInfluencer.AspectTextureRegion It's a class used internally by the `RegionInfluencer` to represent a texture region.
public static class	RegionInfluencer.Random Assigns a random region of `RegionInfluencer#regions` to the particles.
public static class	RegionInfluencer.Single Assigns the first region of `RegionInfluencer#regions` to the particles.

Field Summary

Modifier and Type	Field and Description
private static final String	ASSET_DATA
public String	atlasName
pack-priv ParallelArray.FloatChannel	regionChannel
public Array<RegionInfluencer.AspectTextureRegion>	regions

Constructor Summary

Access	Constructor and Description
public	RegionInfluencer(int regionsCount)
public	RegionInfluencer()
public	RegionInfluencer(TextureRegion... regions) All the regions must be defined on the same Texture
public	RegionInfluencer(Texture texture)
public	RegionInfluencer(RegionInfluencer regionInfluencer)

Method Summary

Modifier and Type	Method and Description
public void	add(TextureRegion... regions)
public void	allocateChannels() Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels. Called during initialization to allocate additional particles channels
public void	clear()
public void	load(AssetManager manager, ResourceData<T> resources) Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.load. Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.load.
public void	read(Json json, JsonValue jsonData) Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.read. Implements com.badlogic.gdx.utils.Json.Serializable.read.
public void	save(AssetManager manager, ResourceData<T> resources) Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.save. Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.save.
public void	setAtlasName(String atlasName)
public void	write(Json json) Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.write. Implements com.badlogic.gdx.utils.Json.Serializable.write.

Field Detail

ASSET_DATA	back to summary
private static final String ASSET_DATA

atlasName	back to summary
public String atlasName

regionChannel	back to summary
pack-priv ParallelArray.FloatChannel regionChannel

regions	back to summary
public Array<RegionInfluencer.AspectTextureRegion> regions

Constructor Detail

RegionInfluencer	back to summary
public RegionInfluencer(int regionsCount)

RegionInfluencer	back to summary
public RegionInfluencer()

RegionInfluencer	back to summary
public RegionInfluencer(TextureRegion... regions) All the regions must be defined on the same Texture

RegionInfluencer	back to summary
public RegionInfluencer(Texture texture)

RegionInfluencer	back to summary
public RegionInfluencer(RegionInfluencer regionInfluencer)

Method Detail

add	back to summary
public void add(TextureRegion... regions)

allocateChannels	back to summary
public void allocateChannels() Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels. Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels. Called during initialization to allocate additional particles channels Annotations @Override

allocateChannels

back to summary

public void allocateChannels()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels.

Called during initialization to allocate additional particles channels

Annotations

@Override

clear	back to summary
public void clear()

load	back to summary
public void load(AssetManager manager, ResourceData<T> resources) Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.load. Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.load. Annotations @Override

load

back to summary

public void load(AssetManager manager, ResourceData<T> resources)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.load.

Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.load.

Annotations

@Override

read	back to summary
public void read(Json json, JsonValue jsonData) Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.read. Implements com.badlogic.gdx.utils.Json.Serializable.read. Annotations @Override

read

back to summary

public void read(Json json, JsonValue jsonData)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.read.

Implements com.badlogic.gdx.utils.Json.Serializable.read.

Annotations

@Override

save	back to summary
public void save(AssetManager manager, ResourceData<T> resources) Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.save. Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.save. Annotations @Override

save

back to summary

public void save(AssetManager manager, ResourceData<T> resources)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.save.

Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.save.

Annotations

@Override

setAtlasName	back to summary
public void setAtlasName(String atlasName)

write	back to summary
public void write(Json json) Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.write. Implements com.badlogic.gdx.utils.Json.Serializable.write. Annotations @Override

write

back to summary

public void write(Json json)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.write.

Implements com.badlogic.gdx.utils.Json.Serializable.write.

Annotations

@Override

com.badlogic.gdx.graphics.g3d.particles.influencers back to summary

public Class RegionInfluencer.Animated

Class Inheritance

extends RegionInfluencer

java.lang.Object
com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent
com.badlogic.gdx.graphics.g3d.particles.influencers.Influencer
com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer
com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer.Animated

Assigns a region to the particles using the particle life percent to calculate the current index in the RegionInfluencer#regions array.

Field Summary

Modifier and Type	Field and Description
pack-priv ParallelArray.FloatChannel	lifeChannel

Inherited from com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer:: atlasName regionChannel regions

Constructor Summary

Access	Constructor and Description
public	Animated()
public	Animated(RegionInfluencer.Animated regionInfluencer)
public	Animated(TextureRegion textureRegion)
public	Animated(Texture texture)

Method Summary

Modifier and Type	Method and Description
public void	allocateChannels() Overrides com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer.allocateChannels. Called during initialization to allocate additional particles channels
public RegionInfluencer.Animated	copy() Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy.
public void	update() Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.update. Called to execute the component behavior.

Inherited from com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer:: add clear load read save setAtlasName write

Field Detail

lifeChannel	back to summary
pack-priv ParallelArray.FloatChannel lifeChannel

Constructor Detail

Animated	back to summary
public Animated()

Animated	back to summary
public Animated(RegionInfluencer.Animated regionInfluencer)

Animated	back to summary
public Animated(TextureRegion textureRegion)

Animated	back to summary
public Animated(Texture texture)

Method Detail

allocateChannels	back to summary
public void allocateChannels() Overrides com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer.allocateChannels. Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels. Called during initialization to allocate additional particles channels Annotations @Override

allocateChannels

back to summary

public void allocateChannels()

Overrides com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer.allocateChannels.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels.

Called during initialization to allocate additional particles channels

Annotations

@Override

copy	back to summary
public RegionInfluencer.Animated copy() Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy. Annotations @Override

copy

back to summary

public RegionInfluencer.Animated copy()

Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy.

Annotations

@Override

update	back to summary
public void update() Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.update. Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.update. Called to execute the component behavior. Annotations @Override

update

back to summary

public void update()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.update.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.update.

Called to execute the component behavior.

Annotations

@Override

com.badlogic.gdx.graphics.g3d.particles.influencers back to summary

public Class RegionInfluencer.AspectTextureRegion

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer.AspectTextureRegion

It's a class used internally by the RegionInfluencer to represent a texture region. It contains the uv coordinates of the region and the region inverse aspect ratio.

Field Summary

Modifier and Type	Field and Description
public float	halfInvAspectRatio
public String	imageName
public float	u
public float	u2
public float	v
public float	v2

Constructor Summary

Access	Constructor and Description
public	AspectTextureRegion()
public	AspectTextureRegion(RegionInfluencer.AspectTextureRegion aspectTextureRegion)
public	AspectTextureRegion(TextureRegion region)

Method Summary

Modifier and Type	Method and Description
public void	set(TextureRegion region)
public void	set(RegionInfluencer.AspectTextureRegion aspectTextureRegion)
public void	updateUV(TextureAtlas atlas)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

halfInvAspectRatio	back to summary
public float halfInvAspectRatio

imageName	back to summary
public String imageName

u	back to summary
public float u

u2	back to summary
public float u2

v	back to summary
public float v

v2	back to summary
public float v2

Constructor Detail

AspectTextureRegion	back to summary
public AspectTextureRegion()

AspectTextureRegion	back to summary
public AspectTextureRegion(RegionInfluencer.AspectTextureRegion aspectTextureRegion)

AspectTextureRegion	back to summary
public AspectTextureRegion(TextureRegion region)

Method Detail

set	back to summary
public void set(TextureRegion region)

set	back to summary
public void set(RegionInfluencer.AspectTextureRegion aspectTextureRegion)

updateUV	back to summary
public void updateUV(TextureAtlas atlas)

com.badlogic.gdx.graphics.g3d.particles.influencers back to summary

public Class RegionInfluencer.Random

Class Inheritance

extends RegionInfluencer

java.lang.Object
com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent
com.badlogic.gdx.graphics.g3d.particles.influencers.Influencer
com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer
com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer.Random

Assigns a random region of RegionInfluencer#regions to the particles.

Field Summary

Inherited from com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer:: atlasName regionChannel regions

Constructor Summary

Access	Constructor and Description
public	Random()
public	Random(RegionInfluencer.Random regionInfluencer)
public	Random(TextureRegion textureRegion)
public	Random(Texture texture)

Method Summary

Modifier and Type	Method and Description
public void	activateParticles(int startIndex, int count) Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles. Called to initialize new emitted particles.
public RegionInfluencer.Random	copy() Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy.

Inherited from com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer:: add allocateChannels clear load read save setAtlasName write

Constructor Detail

Random	back to summary
public Random()

Random	back to summary
public Random(RegionInfluencer.Random regionInfluencer)

Random	back to summary
public Random(TextureRegion textureRegion)

Random	back to summary
public Random(Texture texture)

Method Detail

activateParticles

back to summary

public void activateParticles(int startIndex, int count)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles.

Called to initialize new emitted particles.

Annotations

@Override

copy

back to summary

public RegionInfluencer.Random copy()

Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy.

Annotations

@Override

com.badlogic.gdx.graphics.g3d.particles.influencers back to summary

public Class RegionInfluencer.Single

Class Inheritance

extends RegionInfluencer

java.lang.Object
com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent
com.badlogic.gdx.graphics.g3d.particles.influencers.Influencer
com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer
com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer.Single

Assigns the first region of RegionInfluencer#regions to the particles.

Field Summary

Inherited from com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer:: atlasName regionChannel regions

Constructor Summary

Access	Constructor and Description
public	Single()
public	Single(RegionInfluencer.Single regionInfluencer)
public	Single(TextureRegion textureRegion)
public	Single(Texture texture)

Method Summary

Modifier and Type	Method and Description
public RegionInfluencer.Single	copy() Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy.
public void	init() Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.init. Called once during intialization

Inherited from com.badlogic.gdx.graphics.g3d.particles.influencers.RegionInfluencer:: add allocateChannels clear load read save setAtlasName write

Constructor Detail

Single	back to summary
public Single()

Single	back to summary
public Single(RegionInfluencer.Single regionInfluencer)

Single	back to summary
public Single(TextureRegion textureRegion)

Single	back to summary
public Single(Texture texture)

Method Detail

copy

back to summary

public RegionInfluencer.Single copy()

Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy.

Annotations

@Override

init

back to summary

public void init()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.init.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.init.

Called once during intialization

Annotations

@Override