Package dev.prozilla.pine.core.entity.prefab.camera

Class ControllableCameraPrefab

java.lang.Object

dev.prozilla.pine.core.entity.prefab.Prefab

dev.prozilla.pine.core.entity.prefab.camera.CameraPrefab

dev.prozilla.pine.core.entity.prefab.camera.ControllableCameraPrefab

@Components({CameraControlData.class,CameraData.class,Transform.class})
public class ControllableCameraPrefab
extends CameraPrefab

Field Summary

Fields

Modifier and Type	Field	Description
protected float	boundsHeight
protected float	boundsWidth
protected float	boundsX
protected float	boundsY
protected boolean	disableControlsOnPause
protected boolean	enableBounds
protected float	maxZoom
protected float	minZoom
protected float	movementSpeed
protected float	velocityDamping
protected float	zoomSpeed

Fields inherited from class dev.prozilla.pine.core.entity.prefab.camera.CameraPrefab

backgroundColor

Fields inherited from class dev.prozilla.pine.core.entity.prefab.Prefab

isActive, name, tag

Constructor Summary

Constructors

Constructor	Description
ControllableCameraPrefab(float movementSpeed, float velocityDamping, float zoomSpeed, float minZoom, float maxZoom)

Method Summary

Modifier and Type	Method	Description
protected void	apply(Entity entity)	Adds this prefab's predefined components to a given entity and copies values from this prefab.
void	disableBounds()
void	disableMovement()
void	disableVelocityDamping()
void	disableZoom()
void	setBounds(float x, float y, float width, float height)
void	setDisableControlsOnPause(boolean disableControlsOnPause)
void	setMovementSpeed(float movementSpeed)
void	setVelocityDamping(float velocityDamping)
void	setZoom(float zoomSpeed, float minZoom, float maxZoom)
void	setZoomRange(float minZoom, float maxZoom)
void	setZoomSpeed(float zoomSpeed)

Methods inherited from class dev.prozilla.pine.core.entity.prefab.camera.CameraPrefab

setBackgroundColor

Methods inherited from class dev.prozilla.pine.core.entity.prefab.Prefab

instantiate, instantiate, setActive, setName, setTag

Methods inherited from class java.lang.Object

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

Field Details

movementSpeed

protected float movementSpeed

velocityDamping

protected float velocityDamping

disableControlsOnPause

protected boolean disableControlsOnPause

zoomSpeed

protected float zoomSpeed

minZoom

protected float minZoom

maxZoom

protected float maxZoom

enableBounds

protected boolean enableBounds

boundsX

protected float boundsX

boundsY

protected float boundsY

boundsWidth

protected float boundsWidth

boundsHeight

protected float boundsHeight

Constructor Details

ControllableCameraPrefab

public ControllableCameraPrefab(float movementSpeed,
 float velocityDamping,
 float zoomSpeed,
 float minZoom,
 float maxZoom)

Parameters:

movementSpeed - Movement speed (Set to 0 to disable movement)

velocityDamping - Velocity damping (Set to 0 to disable damping)

zoomSpeed - Zoom speed (Set to 0 to disable zooming)

minZoom - Minimum zoom factor

maxZoom - Maximum zoom factor

Method Details

disableMovement

public void disableMovement()

setMovementSpeed

public void setMovementSpeed(float movementSpeed)

disableVelocityDamping

public void disableVelocityDamping()

setVelocityDamping

public void setVelocityDamping(float velocityDamping)

disableZoom

public void disableZoom()

setZoom

public void setZoom(float zoomSpeed,
 float minZoom,
 float maxZoom)

setZoomSpeed

public void setZoomSpeed(float zoomSpeed)

setZoomRange

public void setZoomRange(float minZoom,
 float maxZoom)

disableBounds

public void disableBounds()

setBounds

public void setBounds(float x,
 float y,
 float width,
 float height)

setDisableControlsOnPause

public void setDisableControlsOnPause(boolean disableControlsOnPause)

apply

protected void apply(Entity entity)

Description copied from class: Prefab

Adds this prefab's predefined components to a given entity and copies values from this prefab.

Overrides:

apply in class CameraPrefab