Camera

Functions

int SO3CameraCreate (mmachine m)
 main include
int SO3CameraLookAt (mmachine m)
 SO3CameraLookAt : Set a "look at" on the camera.
int SO3CameraGetDirection (mmachine m)
 SO3CameraGetDirection : Get the direction of a camera.
int SO3CameraGetDerivedDirection (mmachine m)
 SO3CameraGetDirection : Get the derivated direction of a camera.
int SO3CameraGetDerivedUp (mmachine m)
 SO3CameraGetDerivedUp : Gets the derived up vector of the camera, including any rotation inherited from a node attachment and reflection matrix.
int SO3CameraSetViewport (mmachine m)
 SO3CameraSetViewport : Attach a camera to a viewport.
int SO3CameraSetFocalLenght (mmachine m)
 SO3CameraSetFocalLenght : defines focal length of a camera.
int SO3CameraGetFocalLenght (mmachine m)
 SO3CameraGetFocalLenght : Get the focal length of a camera.
int SO3CameraSetFOVy (mmachine m)
 SO3CameraSetFOVy : defines FOVy of a camera.
int SO3CameraGetFOVy (mmachine m)
 SO3CameraGetFOVy : Get the FOVy of a camera.
int SO3CameraSetPolygonMode (mmachine m)
 SO3CameraSetPolygonMode : Set the polygon Mode for a given camera.
int SO3CameraGetPolygonMode (mmachine m)
 SO3CameraGetPolygonMode : Get the Polygon mode of a camera.
int SO3CameraSetProjectionType (mmachine m)
 SO3CameraSetProjectionType : Sets the type of projection to use (orthographic or perspective). Default is perspective.
int SO3CameraGetProjectionType (mmachine m)
 SO3CameraGetProjectionType : Get the camera projection type.
int SO3CameraSetOrthoWindow (mmachine m)
 SO3CameraSetOrthoWindow : Sets the orthographic window settings, for use with orthographic rendering only.
int SO3CameraGetOrthoWindow (mmachine m)
 SO3CameraGetOrthoWindow : Gets the orthographic window settings, for use with orthographic rendering only.
int SO3CameraSetNearClipDistance (mmachine m)
 SO3CameraSetNearClipDistance : defines near clip distance of a camera.
int SO3CameraGetNearClipDistance (mmachine m)
 SO3CameraGetNearClipDistance : Get the near clip distance of a camera.
int SO3CameraSetFarClipDistance (mmachine m)
 SO3CameraSetFarClipDistance : defines far clip distance of a camera.
int SO3CameraGetFarClipDistance (mmachine m)
 SO3CameraGetFarClipDistance : Get the far clip distance of a camera.
int SO3CameraGetViewport (mmachine m)
 SO3CameraGetViewport : Get the current viewport attached to a camera.
int SO3CameraGetNumRenderedFaces (mmachine m)
 SO3CameraGetNumRenderedFaces : Get the numbered of rendered faces for a camera.
int SO3CameraSetProjectionMatrix (mmachine m)
 SO3CameraSetProjectionMatrix : Set the camera projection matrix.

Detailed Description

Scol functions definition

Function Documentation

int SO3CameraCreate ( mmachine  m  ) 

main include

SO3CameraCreate : Create a new camea Prototype: fun [SO3_SCENE S] SO3_OBJECT

Parameters:
SO3_SCENE : current scene
S : given name for the new camera
Returns:
SO3_OBJECT : Created camera if success , NIL otherwise

Definition at line 60 of file SCOLCamera.cpp.

int SO3CameraGetDerivedDirection ( mmachine  m  ) 

SO3CameraGetDirection : Get the derivated direction of a camera.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters:
SO3_OBJECT : current camera
Returns:
[F F F] : Derivated direction vector if success , NIL otherwise

Definition at line 207 of file SCOLCamera.cpp.

int SO3CameraGetDerivedUp ( mmachine  m  ) 

SO3CameraGetDerivedUp : Gets the derived up vector of the camera, including any rotation inherited from a node attachment and reflection matrix.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters:
SO3_OBJECT : current camera
Returns:
[F F F] : Derivated up vector if success , NIL otherwise

Definition at line 255 of file SCOLCamera.cpp.

int SO3CameraGetDirection ( mmachine  m  ) 

SO3CameraGetDirection : Get the direction of a camera.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters:
SO3_OBJECT : current camera
Returns:
(F F F] : Direction vector if success , NIL otherwise

Definition at line 159 of file SCOLCamera.cpp.

int SO3CameraGetFarClipDistance ( mmachine  m  ) 

SO3CameraGetFarClipDistance : Get the far clip distance of a camera.

Prototype: fun [SO3_OBJECT] F

Parameters:
SO3_OBJECT : current camera
Returns:
F : Far clip distance if success , NIL otherwise

Definition at line 919 of file SCOLCamera.cpp.

int SO3CameraGetFocalLenght ( mmachine  m  ) 

SO3CameraGetFocalLenght : Get the focal length of a camera.

Prototype: fun [SO3_OBJECT] F

Parameters:
SO3_OBJECT : current camera
Returns:
F : focal length if success , NIL otherwise

Definition at line 400 of file SCOLCamera.cpp.

int SO3CameraGetFOVy ( mmachine  m  ) 

SO3CameraGetFOVy : Get the FOVy of a camera.

Prototype: fun [SO3_OBJECT] F

Parameters:
SO3_OBJECT : current camera
Returns:
F : FOVy if success , NIL otherwise

Definition at line 479 of file SCOLCamera.cpp.

int SO3CameraGetNearClipDistance ( mmachine  m  ) 

SO3CameraGetNearClipDistance : Get the near clip distance of a camera.

Prototype: fun [SO3_OBJECT] F

Parameters:
SO3_OBJECT : current camera
Returns:
F : Near clip distance if success , NIL otherwise

Definition at line 845 of file SCOLCamera.cpp.

int SO3CameraGetNumRenderedFaces ( mmachine  m  ) 

SO3CameraGetNumRenderedFaces : Get the numbered of rendered faces for a camera.

Prototype: fun [SO3_OBJECT] I

Parameters:
SO3_OBJECT : current camera
Returns:
I : numbered of rendered faces if success , NIL otherwise

Definition at line 1001 of file SCOLCamera.cpp.

int SO3CameraGetOrthoWindow ( mmachine  m  ) 

SO3CameraGetOrthoWindow : Gets the orthographic window settings, for use with orthographic rendering only.

Prototype: fun [SO3_OBJECT] [F F]

Parameters:
SO3_OBJECT : current camera
Returns:
[F F]: Width and height of the orthographic window, in world unit, if success , NIL otherwise

Definition at line 752 of file SCOLCamera.cpp.

int SO3CameraGetPolygonMode ( mmachine  m  ) 

SO3CameraGetPolygonMode : Get the Polygon mode of a camera.

Prototype: fun [SO3_OBJECT] I

Parameters:
SO3_OBJECT : current camera
Returns:
I : Polygon Mode if success , NIL otherwise

For polygon mode, values are :

  • SO3_POLY_POINTS
  • SO3_POLY_SOLID
  • SO3_POLY_WIREFRAME

Definition at line 572 of file SCOLCamera.cpp.

int SO3CameraGetProjectionType ( mmachine  m  ) 

SO3CameraGetProjectionType : Get the camera projection type.

Prototype: fun [SO3_OBJECT] I

Parameters:
SO3_OBJECT : current camera
Returns:
I : Projection type if success , NIL otherwise

For projection type, values are :

  • SO3_PROJECTION_PERSPECTIVE
  • SO3_PROJECTION_ORTHOGRAPHIC

Definition at line 667 of file SCOLCamera.cpp.

int SO3CameraGetViewport ( mmachine  m  ) 

SO3CameraGetViewport : Get the current viewport attached to a camera.

Prototype: fun [SO3_OBJECT] SO3_VIEWPORT

Parameters:
SO3_OBJECT : current camera
Returns:
SO3_VIEWPORT : Attached viewport if success , NIL otherwise

Definition at line 955 of file SCOLCamera.cpp.

int SO3CameraLookAt ( mmachine  m  ) 

SO3CameraLookAt : Set a "look at" on the camera.

Prototype: fun [SO3_OBJECT [F F F]] I

Parameters:
SO3_OBJECT : current camera
[F F F] : The "look at" vector
Returns:
I : 1 if success , NIL otherwise

Definition at line 109 of file SCOLCamera.cpp.

int SO3CameraSetFarClipDistance ( mmachine  m  ) 

SO3CameraSetFarClipDistance : defines far clip distance of a camera.

Prototype: fun [SO3_OBJECT F] I

Parameters:
SO3_OBJECT : current camera
F : Far clip distance
Returns:
I : 1 if success , NIL otherwise

Definition at line 882 of file SCOLCamera.cpp.

int SO3CameraSetFocalLenght ( mmachine  m  ) 

SO3CameraSetFocalLenght : defines focal length of a camera.

Prototype: fun [SO3_OBJECT F] I

Parameters:
SO3_OBJECT : current camera
F : focal length
Returns:
I : 1 if success , NIL otherwise

Definition at line 353 of file SCOLCamera.cpp.

int SO3CameraSetFOVy ( mmachine  m  ) 

SO3CameraSetFOVy : defines FOVy of a camera.

Prototype: fun [SO3_OBJECT F] I

Parameters:
SO3_OBJECT : current camera
F : given FOVy
Returns:
I : 1 if success , NIL otherwise

Definition at line 439 of file SCOLCamera.cpp.

int SO3CameraSetNearClipDistance ( mmachine  m  ) 

SO3CameraSetNearClipDistance : defines near clip distance of a camera.

Prototype: fun [SO3_OBJECT F] I

Parameters:
SO3_OBJECT : current camera
F : Near clip distance
Returns:
I : 1 if success , NIL otherwise

Definition at line 801 of file SCOLCamera.cpp.

int SO3CameraSetOrthoWindow ( mmachine  m  ) 

SO3CameraSetOrthoWindow : Sets the orthographic window settings, for use with orthographic rendering only.

Prototype: fun [SO3_OBJECT F F] I

Parameters:
SO3_OBJECT : current camera
F : width in world unit
F : height in world unit
Returns:
I : 1 if success , NIL otherwise

Definition at line 711 of file SCOLCamera.cpp.

int SO3CameraSetPolygonMode ( mmachine  m  ) 

SO3CameraSetPolygonMode : Set the polygon Mode for a given camera.

Prototype: fun [SO3_OBJECT I] I

Parameters:
SO3_OBJECT : current camera
I : Polygon Mode

For polygon mode, values are :

  • SO3_POLY_POINTS
  • SO3_POLY_SOLID
  • SO3_POLY_WIREFRAME
Returns:
I : 1 if success , NIL otherwise

Definition at line 523 of file SCOLCamera.cpp.

int SO3CameraSetProjectionMatrix ( mmachine  m  ) 

SO3CameraSetProjectionMatrix : Set the camera projection matrix.

Prototype: fun [SO3_OBJECT [[F F F F] [F F F F] [F F F F] [F F F F]]] I

Parameters:
SO3_OBJECT : current camera
[[F F F F] [F F F F] [F F F F] [F F F F]] : projection matrix
Returns:
I : 1 if success, NIL otherwise

Definition at line 1039 of file SCOLCamera.cpp.

int SO3CameraSetProjectionType ( mmachine  m  ) 

SO3CameraSetProjectionType : Sets the type of projection to use (orthographic or perspective). Default is perspective.

Prototype: fun [SO3_OBJECT I] I

Parameters:
SO3_OBJECT : current camera
I : Projection Type Mode

For polygon mode, values are :

  • SO3_PROJECTION_ORTHOGRAPHIC
  • SO3_PROJECTION_PERSPECTIVE
Returns:
I : 1 if success , NIL otherwise

Definition at line 621 of file SCOLCamera.cpp.

int SO3CameraSetViewport ( mmachine  m  ) 

SO3CameraSetViewport : Attach a camera to a viewport.

Prototype: fun [SO3_VIEWPORT SO3_OBJECT] I

Parameters:
SO3_VIEWPORT : current viewport
SO3_OBJECT : current camera
Returns:
1 : 1 if success , NIL otherwise

Definition at line 304 of file SCOLCamera.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Mon Oct 31 14:42:33 2011 for SO3Engine by  doxygen 1.6.3