com.almasb.fxgl.entity.components

Class ViewComponent

java.lang.Object

com.almasb.fxgl.entity.component.Component

com.almasb.fxgl.entity.components.ViewComponent

public class ViewComponent
extends Component

Adds a game scene view to an entity. To change view of an entity use setView(Node).

Author:

Almas Baimagambetov (AlmasB) ([email protected])

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<RenderLayer>	renderLayer

Field Summary

Fields inherited from class com.almasb.fxgl.entity.component.Component

entity

Constructor Summary

Constructors

Constructor and Description
ViewComponent() Creates view component with no graphics.
ViewComponent(javafx.scene.Node graphics) Creates view component with given graphics.
ViewComponent(javafx.scene.Node graphics, RenderLayer renderLayer) Creates view component with given graphics and given render layer.
ViewComponent(RenderLayer renderLayer) Creates view component with given render layer.

Method Summary

Modifier and Type	Method and Description
RenderLayer	getRenderLayer()
EntityView	getView()
void	onAdded() Called after the component is added to entity.
void	onRemoved() Called before the component is removed from entity.
javafx.beans.property.ObjectProperty<RenderLayer>	renderLayerProperty()
void	setAnimatedTexture(AnimatedTexture texture, boolean loop, boolean removeEntityOnFinish)
void	setAnimatedTexture(String textureName, int numFrames, javafx.util.Duration duration, boolean loop, boolean removeEntityOnFinish)
void	setRenderLayer(RenderLayer renderLayer) Set render layer for this entity.
void	setTexture(String textureName) Convenience method to set texture as view.
void	setTexture(String textureName, boolean generateBoundingBox) Convenience method to set texture as view.
void	setView(javafx.scene.Node view) Set view without generating bounding boxes from view.
void	setView(javafx.scene.Node view, boolean generateBoundingBox) Set view.
String	toString()

Methods inherited from class com.almasb.fxgl.entity.component.Component

getEntity, isPaused, onUpdate, pause, resume

Methods inherited from class java.lang.Object

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

Property Detail

renderLayer

public javafx.beans.property.ObjectProperty<RenderLayer> renderLayerProperty

See Also:

getRenderLayer(), setRenderLayer(RenderLayer)

Constructor Detail

ViewComponent

public ViewComponent()

Creates view component with no graphics.

ViewComponent

public ViewComponent(javafx.scene.Node graphics)

Creates view component with given graphics.

Parameters:

graphics - the graphics

ViewComponent

public ViewComponent(RenderLayer renderLayer)

Creates view component with given render layer.

Parameters:

renderLayer - render layer to use for view

ViewComponent

public ViewComponent(javafx.scene.Node graphics,
                     RenderLayer renderLayer)

Creates view component with given graphics and given render layer.

Parameters:

graphics - the graphics

renderLayer - render layer to use for view

Method Detail

getRenderLayer

public RenderLayer getRenderLayer()

Returns:

render layer

renderLayerProperty

public javafx.beans.property.ObjectProperty<RenderLayer> renderLayerProperty()

See Also:

getRenderLayer(), setRenderLayer(RenderLayer)

setRenderLayer

public void setRenderLayer(RenderLayer renderLayer)

Set render layer for this entity. Render layer determines how an entity is rendered relative to other entities. The layer with higher index() will be rendered on top of the layer with lower index(). By default an entity has the very top layer with highest index equal to [Integer.MAX_VALUE].

Parameters:

renderLayer - the render layer

getView

public EntityView getView()

Returns:

view

setView

public void setView(javafx.scene.Node view)

Set view without generating bounding boxes from view.

Parameters:

view - the view

setView

public void setView(javafx.scene.Node view,
                    boolean generateBoundingBox)

Set view. The generate bbox flag tells the component whether it should generate bbox from the given view. Note: the generated bounding box is an approximation based on the layout bounds of the view object.

Parameters:

view - the view

generateBoundingBox - generate bbox flag

setTexture

public void setTexture(String textureName)

Convenience method to set texture as view.

Parameters:

textureName - name of texture

setTexture

public void setTexture(String textureName,
                       boolean generateBoundingBox)

Convenience method to set texture as view.

Parameters:

textureName - name of texture

generateBoundingBox - generate bbox from view flag

setAnimatedTexture

public void setAnimatedTexture(AnimatedTexture texture,
                               boolean loop,
                               boolean removeEntityOnFinish)

setAnimatedTexture

public void setAnimatedTexture(String textureName,
                               int numFrames,
                               javafx.util.Duration duration,
                               boolean loop,
                               boolean removeEntityOnFinish)

onAdded

public void onAdded()

Description copied from class: Component

Called after the component is added to entity.

Overrides:

onAdded in class Component

onRemoved

public void onRemoved()

Description copied from class: Component

Called before the component is removed from entity.

Overrides:

onRemoved in class Component

toString

public String toString()

Overrides:

toString in class Component