Thinkscroller Version 1.5
Reference Manual / API Documentation
ThinksquirrelSoftware.Thinkscroller.Parallax Class Reference
Inheritance diagram for ThinksquirrelSoftware.Thinkscroller.Parallax:
Collaboration diagram for ThinksquirrelSoftware.Thinkscroller.Parallax:

List of all members.

Public Member Functions

void DoResetPosition ()
 Resets the position of object layers.
void DoResetPosition (Vector3 resetPosition)
 Resets the position of object layers.
void DoScroll (float xScrollValue, float yScrollValue)
 Scrolls the parallax manager.
void DoScroll (Vector2 scrollValue)
 Scrolls the parallax manager.
float GetBaseSpeed ()
 Gets the global base speed for parallax scrolling.
float GetCameraAspectRatio ()
 Gets the aspect ratio of the parallax camera viewport.
float GetCameraHeight ()
 Gets the height of the parallax camera viewport.
float GetCameraWidth ()
 Gets the width of the parallax camera viewport.
Camera GetParallaxCamera ()
 Gets the parallax camera.
ScrollConstraints GetScrollConstraints ()
 Gets the current scroll movement constriants.
void RefreshLayers ()
 Refreshes the scroll layers.
void SetBaseSpeed (float baseSpeed)
 Sets the global base speed for parallax scrolling.
void SetParallaxCamera (Camera parallaxCamera)
 Sets the parallax camera.
void SetScrollConstraints (ScrollConstraints scrollConstraints)
 Sets the current scroll movement constraints.

Static Public Member Functions

static void CreateManager ()
 Creates a parallax manager if no current manager exists.
static Vector2 GetRawScrollVector (ScrollLayer layer, Vector2 scrollValue)
 Gets a layer's raw scroll vector from an input value.
static void RefreshAllBillboards ()
 Refreshes all billboard meshes. Note that this only updates vertices.
static void ResetAllObjectLayers (Vector3 resetPosition)
 Resets the position of object layers.
static void ResetAllObjectLayers ()
 Resets the position of object layers.
static void Scroll (float xScrollValue, float yScrollValue)
 Scrolls the parallax manager.
static void Scroll (Vector2 scrollValue)
 Scrolls the parallax manager.

Properties

bool automatic [get, set]
 If true, the camera's viewport is set automatically.
bool autoRefreshBillboards [get, set]
 If true, billboard meshes are automatically regenerated every LateUpdate().
static Parallax instance [get]
 The singleton instance of the parallax manager.
int Length [get]
 The number of active scroll layers in the scene.
Vector2 maxSize [get, set]
 If the camera viewport is not automatic, the maximum viewport size.
Vector2 minSize [get, set]
 If the camera viewport is not automatic, the minimum viewport size.
ScrollLayer this[int i] [get]
 The list of active scroll layers in the scene, ordered by weight.

The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Enumerations Properties