org.cesiumjs.cs.scene

Class CreditDisplay

java.lang.Object

org.cesiumjs.cs.scene.CreditDisplay

@JsType(isNative=true,
        namespace="Cesium",
        name="CreditDisplay")
public class CreditDisplay
extends Object

The credit display is responsible for displaying credits on screen.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
com.google.gwt.dom.client.Element	container The HTML element where credits will be displayed.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreditDisplay()
	CreditDisplay(com.google.gwt.dom.client.Element container) The credit display is responsible for displaying credits on screen.
	CreditDisplay(com.google.gwt.dom.client.Element container, String delimiter) The credit display is responsible for displaying credits on screen.
	CreditDisplay(com.google.gwt.dom.client.Element container, String delimiter, com.google.gwt.dom.client.Element viewport) The credit display is responsible for displaying credits on screen.

Method Summary

Modifier and Type	Method and Description
void	addCredit(Credit credit) Adds a credit to the list of current credits to be displayed in the credit container
void	addDefaultCredit(Credit credit) Adds credits that will persist until they are removed
void	beginFrame() Resets the credit display to a beginning of frame state, clearing out current credits.
void	destroy() Destroys the resources held by this object.
void	endFrame() Sets the credit display to the end of frame state, displaying credits from the last frame in the credit container.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.
void	removeDefaultCredit(Credit credit) Removes a default credit
void	update() Updates the credit display before a new frame is rendered.

Methods inherited from class java.lang.Object

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

Field Detail

container

@JsProperty
public com.google.gwt.dom.client.Element container

The HTML element where credits will be displayed.

Constructor Detail

CreditDisplay

@JsConstructor
protected CreditDisplay()

CreditDisplay

@JsConstructor
public CreditDisplay(com.google.gwt.dom.client.Element container)

The credit display is responsible for displaying credits on screen.

Parameters:

container - The HTML element where credits will be displayed

CreditDisplay

@JsConstructor
public CreditDisplay(com.google.gwt.dom.client.Element container,
                                    String delimiter)

The credit display is responsible for displaying credits on screen.

Parameters:

container - The HTML element where credits will be displayed

delimiter - The string to separate text credits

CreditDisplay

@JsConstructor
public CreditDisplay(com.google.gwt.dom.client.Element container,
                                    String delimiter,
                                    com.google.gwt.dom.client.Element viewport)

The credit display is responsible for displaying credits on screen.

Parameters:

container - The HTML element where credits will be displayed

delimiter - The string to separate text credits

viewport - The HTML element that will contain the credits popup

Method Detail

addCredit

@JsMethod
public void addCredit(Credit credit)

Adds a credit to the list of current credits to be displayed in the credit container

Parameters:

credit - The credit to display

addDefaultCredit

@JsMethod
public void addDefaultCredit(Credit credit)

Adds credits that will persist until they are removed

Parameters:

credit - The credit to added to defaults

beginFrame

@JsMethod
public void beginFrame()

Resets the credit display to a beginning of frame state, clearing out current credits.

destroy

@JsMethod
public void destroy()

Destroys the resources held by this object. Destroying an object allows for deterministic release of resources, instead of relying on the garbage collector to destroy this object. Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

endFrame

@JsMethod
public void endFrame()

Sets the credit display to the end of frame state, displaying credits from the last frame in the credit container.

isDestroyed

@JsMethod
public boolean isDestroyed()

Returns true if this object was destroyed; otherwise, false.

Returns:

true if this object was destroyed; otherwise, false.

removeDefaultCredit

@JsMethod
public void removeDefaultCredit(Credit credit)

Removes a default credit

Parameters:

credit - The credit to be removed from defaults

update

@JsMethod
public void update()

Updates the credit display before a new frame is rendered.