Package com.jme3.scene.control

Class BillboardControl

java.lang.Object

com.jme3.scene.control.AbstractControl

com.jme3.scene.control.BillboardControl

All Implemented Interfaces:

Savable, Control, JmeCloneable, Cloneable

public class BillboardControl
extends AbstractControl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BillboardControl.Alignment	Determines how the billboard is aligned to the screen/camera.

Field Summary

Fields inherited from class com.jme3.scene.control.AbstractControl

enabled, spatial

Constructor Summary

Constructors

Constructor	Description
BillboardControl()

Method Summary

Modifier and Type	Method	Description
protected void	controlRender(RenderManager rm, ViewPort vp)	To be implemented in subclass.
protected void	controlUpdate(float tpf)	To be implemented in subclass.
BillboardControl.Alignment	getAlignment()	Returns the alignment this Billboard is set too.
void	read(JmeImporter importer)
void	setAlignment(BillboardControl.Alignment alignment)	Sets the type of rotation this Billboard will have.
void	write(JmeExporter e)

Methods inherited from class com.jme3.scene.control.AbstractControl

cloneFields, cloneForSpatial, getSpatial, isEnabled, jmeClone, render, setEnabled, setSpatial, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BillboardControl

public BillboardControl()

Method Details

controlUpdate

protected void controlUpdate(float tpf)

Description copied from class: AbstractControl

To be implemented in subclass.

Specified by:

controlUpdate in class AbstractControl

Parameters:

tpf - time per frame (in seconds)

controlRender

protected void controlRender(RenderManager rm,
 ViewPort vp)

Description copied from class: AbstractControl

To be implemented in subclass.

Specified by:

controlRender in class AbstractControl

Parameters:

rm - the RenderManager rendering the controlled Spatial (not null)

vp - the ViewPort being rendered (not null)

getAlignment

public BillboardControl.Alignment getAlignment()

Returns the alignment this Billboard is set too.

Returns:

The alignment of rotation, AxialY, AxialZ, Camera or Screen.

setAlignment

public void setAlignment(BillboardControl.Alignment alignment)

Sets the type of rotation this Billboard will have. The alignment can be Camera, Screen, AxialY, or AxialZ. Invalid alignments will assume no billboard rotation.

Parameters:

alignment - the desired alignment (Camera/Screen/AxialY/AxialZ)

write

public void write(JmeExporter e)
           throws IOException

Specified by:

write in interface Savable

Overrides:

write in class AbstractControl

Throws:

IOException

read

public void read(JmeImporter importer)
          throws IOException

Specified by:

read in interface Savable

Overrides:

read in class AbstractControl

Throws:

IOException