The LSCamera class is the representation of a camera object within SCENE.
More...
#include <lscamera.h>
|
void | ref () const |
| Increments the internal reference counter. More...
|
|
void | unref () const |
| Decrements the internal reference counter. More...
|
|
The LSCamera class is the representation of a camera object within SCENE.
- Version
- SCENE API Version 2.0.0.
◆ CameraMode
The list of supported camera types.
- Version
- SCENE API Version 2.0.0.
◆ getCameraMode()
Get the camera mode.
- Returns
- The camera mode.
- Version
- SCENE API Version 2.0.0.
◆ setCameraMode()
Set the camera mode.
- Parameters
-
mode | The camera mode which will be activated. |
- Version
- SCENE API Version 2.0.0.
◆ getCamPosition()
Eigen::Vector3d getCamPosition |
( |
| ) |
const |
Get the camera position.
- Returns
- The camera position.
- Version
- SCENE API Version 2.0.0.
◆ setCamPosition()
void setCamPosition |
( |
const Eigen::Vector3d & |
pos | ) |
|
Set the camera position.
This is broken in older API versions before and including 2.0.21.3610!
- Parameters
-
◆ getCamDirection()
Eigen::Vector3d getCamDirection |
( |
| ) |
const |
Get the camera direction.
- Returns
- The camera direction.
- Version
- SCENE API Version 2.0.0.
◆ setCamDirection()
void setCamDirection |
( |
const Eigen::Vector3d & |
dir | ) |
|
Set the camera direction.
- Parameters
-
- Version
- SCENE API Version 2.0.0.
◆ getCamDirUp()
Eigen::Vector3d getCamDirUp |
( |
| ) |
const |
Get camera up direction.
- Returns
- The camera up direction.
- Version
- SCENE API Version 2.0.0.
◆ setCamDirUp()
void setCamDirUp |
( |
const Eigen::Vector3d & |
dir | ) |
const |
Set camera up direction.
- Parameters
-
dir | The camera up direction. |
- Version
- SCENE API Version 2.0.0.
◆ getCamPitch()
float getCamPitch |
( |
| ) |
const |
Get the camera pitch.
- Returns
- The camera pitch.
- Version
- SCENE API Version 2.0.0.
◆ setCamPitch()
void setCamPitch |
( |
float |
pitch | ) |
|
Sets the camera pitch.
- Parameters
-
- Version
- SCENE API Version 2.0.0.
◆ getCamYaw()
float getCamYaw |
( |
| ) |
const |
Get the camera yaw.
- Returns
- The camera yaw.
- Version
- SCENE API Version 2.0.0.
◆ setCamYaw()
void setCamYaw |
( |
float |
yaw | ) |
|
Set the camera yaw.
- Parameters
-
- Version
- SCENE API Version 2.0.0.
◆ getCamRoll()
float getCamRoll |
( |
| ) |
const |
Get the camera roll.
- Returns
- The camera roll.
- Version
- SCENE API Version 2.0.0.
◆ setCamRoll()
void setCamRoll |
( |
float |
roll | ) |
|
Set the camera roll.
- Parameters
-
- Version
- SCENE API Version 2.0.0.
◆ getCamAspectRatio()
double getCamAspectRatio |
( |
| ) |
const |
Get the camera aspect ratio.
- Returns
- The camera aspect ratio.
- Version
- SCENE API Version 2.0.0.
◆ setCamAspectRatio()
void setCamAspectRatio |
( |
double |
aspectRatio | ) |
|
Set the camera aspect ratio.
- Parameters
-
aspectRatio | The camera aspect ratio. |
- Version
- SCENE API Version 2.0.0.
◆ getWidth()
float getWidth |
( |
float |
distance | ) |
const |
Get the width of the viewing frustum at a given distance.
For orthographic cameras the distance input is discarded.
- Parameters
-
distance | The distance at which to calculate the width. |
- Returns
- The width of the viewing frustum.
- Version
- SCENE API Version 2.0.0.
◆ setWidth()
void setWidth |
( |
float |
width, |
|
|
float |
distance |
|
) |
| |
Set the width of the viewing frustum at a given distance.
For orthographic cameras the distance input is discarded.
- Parameters
-
width | The width of the viewing frustum. |
distance | The distance at which to calculate the width. |
- Version
- SCENE API Version 2.0.0.