Scaleform Studio Lua API Reference: scaleform.CameraComponent object reference
scaleform.CameraComponent object reference
Description
An interface to camera component.
Inheritance 
Constructors and accessors
Functions
Parameters
Returns
self : |
The camera component currently in use. | |
rect : |
The desired view rectangle. |
| This function does not return any values. |
Parameters
Returns
self : |
The camera component currently in use. |
number |
The field of view in degrees. |
Parameters
Returns
self : |
The camera component currently in use. | |
pt : |
The desired position. |
| This function does not return any values. |
Parameters
Returns
self : |
The camera component whose position is set. |
|
The position of the camera component. |
Parameters
Returns
self : |
The camera component currently in use. | |
fov : | number |
The desired field of view in degrees. |
| This function does not return any values. |
Parameters
Returns
self : |
The camera component whose position is set. | |
pt : |
The desired position coordinate of the camera component. |
| This function does not return any values. |
Parameters
Returns
self : |
The camera component currently in use. | |
zoom : | number |
The zoom value. |
| This function does not return any values. |
Parameters
Returns
self : |
The camera component currently in use. | |
pt : |
The zoom anchor point. |
| This function does not return any values. |
scaleform.ComponentThe root type of all actor components.
scaleform.Stage.camera () : scaleform.CameraComponentReturns the camera component set on the stage.
scaleform.CameraComponent.center_on_rect (self, rect) Move the camera to center the rect on screen.
self : scaleform.CameraComponentThe camera component currently in use.
rect : scaleform.RectThe desired view rectangle.
scaleform.CameraComponentAn interface to camera component.
scaleform.RectA rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }
scaleform.CameraComponent.fov (self) : numberGet the field of view in degrees.
self : scaleform.CameraComponentThe camera component currently in use.
numberThe field of view in degrees.A numeric value.
scaleform.CameraComponent.look_at (self, pt) Move the camera to the desired position.
self : scaleform.CameraComponentThe camera component currently in use.
pt : scaleform.Point3The desired position.
scaleform.Point3Point3 should be in the form of a table {x=a, y=b, z=c}
{ PropertyType : string, x : number, y : number, z : number, }
scaleform.CameraComponent.position (self) : scaleform.Point3Gets the position of the camera.
self : scaleform.CameraComponentThe camera component whose position is set.
scaleform.Point3The position of the camera component.
scaleform.CameraComponent.set_fov (self, fov) Set the field of view in degrees.
self : scaleform.CameraComponentThe camera component currently in use.
fov : numberThe desired field of view in degrees.
scaleform.CameraComponent.set_position (self, pt) Sets the position of the camera.
self : scaleform.CameraComponentThe camera component whose position is set.
pt : scaleform.Point3The desired position coordinate of the camera component.
scaleform.CameraComponent.set_zoom (self, zoom) Sets the zoom in/out value of the camera component.
self : scaleform.CameraComponentThe camera component currently in use.
zoom : numberThe zoom value.
scaleform.CameraComponent.set_zoom_anchor (self, pt) Sets the zoom anchor point to move the camera to the position of the anchor point.
self : scaleform.CameraComponentThe camera component currently in use.
pt : scaleform.PointThe zoom anchor point.
scaleform.PointPoint should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }
scaleform.CameraComponent.zoom (self) : numberReturns the current zoom value of the camera component.
self : scaleform.CameraComponentThe camera component currently in use.
number scaleform.CameraComponentThe camera component.A string of characters.Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.