Skyline Lua API  Version 1.0
Lua Script Reference for Skyline Game Engine.
LUA_API_Camera.h
Go to the documentation of this file.
1 // | _ ____ __ _
2 // | / \ _ _ _ __ __ _/ ___| ___ / _| |_
3 // | / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
4 // | / ___ \ |_| | | | (_| |___) | (_) | _| |_
5 // | /_/ \_\__,_|_| \__,_|____/ \___/|_| \__|
6 // |
7 // | Aurasoft UK 2008 - 2018 http://www.aurasoft.co.uk
8 // |
9 // | Skyline Game Engine Lua API Documentation
10 // |
11 // | This file belongs to Aurasoft UK for the Skyline Game Engine of all versions.
12 // | This file is not for use in any other software that is not owned by Aurasoft UK and cannot be used by any other
13 // | person outside of the Skyline Game Engine development team.
14 // |
15 // | Copyright - Aurasoft UK & Skyline Game Engine 2008 - 2018
16 // |
17 
18 // SKYLINE LUA CLASS FOR API DOCUMENTATION
19 
26 class camera
27 {
28 public:
29 
42  void setFOV(int fov);
43 
57  float getFOV();
58 
59 
76  void setFarClip(float farClip);
77 
78 
93  void setNearClip(float nearClip);
94 
114  void setCameraMode(string type);
115 
116 
130  void setLodBias(float bias);
131 
132 
148  float3 getPosition(int mode );
149 
163  void setPosition(float x, float y, float z);
164 
165 
166 
182  float4 getOrientation(int mode=0);
183 
198  void setOrientation(float w, float x, float y, float z);
199 
213  float4 getDirection();
214 
229  void setDirection(float x, float y, float z);
230 
231 
245  void attachToEntity(int entityID);
246 
260  void dettachFromEntity(int entityID);
261 
277  void lookAtPos(float x, float y, float z);
278 
293  void lookAtEntity( int objID );
294 
308  void getWorldOrientation();
309 
322  void pitch();
323 
324 
337  void yaw();
338 
339 
352  void roll();
353 
354 
367  void getPitch();
368 
369 
382  void getYaw();
383 
384 
397  void getRoll();
398 
399 
414  void setActiveCamera( int objID );
415 
416 };
void setPosition(float x, float y, float z)
This Function sets the position of the current camera active in scene.
float4 getOrientation(int mode=0)
This Function returns the current cameras world orientation. 0=local space and 1=world space...
void setDirection(float x, float y, float z)
This Function sets the direction of the current camera active in scene.
void getPitch()
Get the pitch of the camera.
void lookAtPos(float x, float y, float z)
Makes the camera look at a specific point in the scene by world space position.
void setFOV(int fov)
This Function sets the current cameras Field of view (fov) by passing the required fov through the fu...
void pitch()
set the pitch of the camera
void setOrientation(float w, float x, float y, float z)
This Function sets the orientation of the current camera active in scene.
void getWorldOrientation()
Get the world orientation of the camera.
float4 getDirection()
This Function returns the current cameras direction.
float getFOV()
This Function returns the current cameras Field of view (fov).
void setNearClip(float nearClip)
This Function sets the view ports near clipping plane.
void getYaw()
Get the yaw of the camera.
float3 getPosition(int mode)
This Function returns the current cameras world position.0=local space and 1=world space...
void getRoll()
Get the roll of the camera.
void roll()
set the roll of the camera
void setLodBias(float bias)
Sets the lod bias to be used by the current camera.
void setFarClip(float farClip)
This Function sets the view ports far clipping plane.
void attachToEntity(int entityID)
Attaches the camera to a scene entity.
void dettachFromEntity(int entityID)
Dettaches the camera from an entity.
void setActiveCamera(int objID)
Set the active camera.
Definition: LUA_API_Camera.h:26
void yaw()
set the yaw of the camera
void setCameraMode(string type)
Set the current camera mode, changing the way this camera can be used.
void lookAtEntity(int objID)
Makes the camera look at a specific entity in the scene.