ofEasyCamfile

ofEasyCamclass

A super simple camera for interacting with objects in 3D space.

Camera Settings

setFov ()

void setFov(float f)

Set the field of view for a perspective camera.

This sets the horizontal field of view for the camera, in degrees. This only operates with perspective cameras, and will have no effect with cameras in orthographic mode.

Parameters

f	The desired field of view for the camera, in degrees.

setNearClip ()

void setNearClip(float f)

setFarClip ()

void setFarClip(float f)

setLensOffset ()

void setLensOffset(const ofVec2f &lensOffset)

Set the "lens offset" applied to this camera.

Ordinarily, the camera is pointed straight down the center of its view frustum. However, it is possible to orient the camera towards a location offset from the center of its frustum. This is called an "assymetric frustum" and is used (for example) in stereo views. It is acheived by applying an offset to the center of projection. This function sets this offset from an ofVec2f argument. For more information see http://www.orthostereo.com/geometryopengl.html.

Parameters

lensOffset The "lens offset" to apply to this camera, encoded in an ofVec2f.

setAspectRatio ()

void setAspectRatio(float aspectRatio)

Set the recommended aspect ratio for a perspective camera.

Sets the aspect ratio of the camera to the desired float, and forces the use of aspect ratio calculations. Currently only used with perspective cameras. The default value (and the value used with orthographic cameras) is the ratio of the viewport's width to the viewport's height.

Parameters

aspectRatio The desired aspect ratio, e.g. 1.3333, 1.6, etc.

setForceAspectRatio ()

void setForceAspectRatio(bool forceAspectRatio)

Set whether or not the aspect ratio of this camera is forced to a non-default setting.

The camera's aspect ratio, by default, is the aspect ratio of your viewport. If you have set a non-default value (with ofCamera::setAspectRatio()), you can toggle whether or not this value is applied.

Parameters

forceAspectRatio Whether or not this camera should use an aspect ratio you have set yourself.

getFov ()

float getFov() const

Get the camera's field of view, in degrees.

Get the horizontal camera's field of view, in degrees. This is only meaningful for perspective cameras.

Returns: The camera's field of view, in degrees.

getNearClip ()

float getNearClip() const

getFarClip ()

float getFarClip() const

getLensOffset ()

ofVec2f getLensOffset() const

Get the "lens offset" applied to this camera, encoded as an ofVec2f.

Ordinarily, the camera is pointed straight down the center of its view frustum. However, it is possible to orient the camera towards a location offset from the center of its frustum. This is called an "asymetric frustum" and is used (for example) in stereo views. It is acheived by applying an offset to the center of projection. This function returns the offset that has been applied, as an ofVec2f. For more information see http://www.orthostereo.com/geometryopengl.html.

Returns: The "lens offset" applied to this camera, encoded in an ofVec2f.

getForceAspectRatio ()

bool getForceAspectRatio() const

Get the boolean state which indicates whether the aspect ratio of this camera is forced to a non-default setting.

Returns: A boolean: whether or not this camera's aspect ratio is set to a non-default value.

getAspectRatio ()

float getAspectRatio() const

Get the aspect ratio of this camera's viewport.

Returns the aspect ratio of this camera's viewport. Usually this will be the ratio of the width to height of your display. Intended for perspective cameras.

Returns: The aspect ratio of this camera's viewport.

OpenGL Setup

setupPerspective ()

void setupPerspective(bool vFlip=true, float fov=60, float nearDist=0, float farDist=0, const ofVec2f &lensOffset=ofVec2f(0.0f, 0.0f))

setupOffAxisViewPortal ()

void setupOffAxisViewPortal(const ofVec3f &topLeft, const ofVec3f &bottomLeft, const ofVec3f &bottomRight)

setVFlip ()

void setVFlip(bool vflip)

isVFlipped ()

bool isVFlipped() const

enableOrtho ()

void enableOrtho()

disableOrtho ()

void disableOrtho()

getOrtho ()

bool getOrtho() const

getImagePlaneDistance ()

float getImagePlaneDistance(ofRectangle viewport=ofRectangle()) const

Rendering

end ()

void end()

Ends rendering with the camera.

OpenGL Matrix

getProjectionMatrix ()

ofMatrix4x4 getProjectionMatrix(ofRectangle viewport=ofRectangle()) const

Access the projection matrix.

Returns: the current 4x4 projection matrix.

getModelViewMatrix ()

ofMatrix4x4 getModelViewMatrix() const

Access the model view matrix.

Returns: the current 4x4 model view matrix.

getModelViewProjectionMatrix ()

ofMatrix4x4 getModelViewProjectionMatrix(ofRectangle viewport=ofRectangle()) const

Coordinate Conversion

worldToScreen ()

ofVec3f worldToScreen(ofVec3f WorldXYZ, ofRectangle viewport=ofRectangle()) const

Obtain the screen coordinates of a point in the 3D world.

Takes an (X,Y,Z) point in your 3D world, encoded as an ofVec3f, and returns the location (also as an ofVec3f) where this point would appear on your (two-dimensional) display. The screen position's "Z coordinate" is set to be the same as your camera's.

Parameters

WorldXYZ	A 3D point in the world, whose screen coordinates you wish to know.
viewport	(Optional) A viewport. The default is ofGetCurrentViewport().

Returns: An ofVec3f containing the screen coordinates of your 3D point of interest.

screenToWorld ()

ofVec3f screenToWorld(ofVec3f ScreenXYZ, ofRectangle viewport=ofRectangle()) const

Obtain the coordinates, in the 3D world, of a 2D point presumed to be on your screen.

Takes a pixel location on your screen, encoded in an ofVec3f, and returns (also as an ofVec3f) the 3D world coordinates of that point. You'll also need to specify a Z value when providing your screen point. This Z value is interpreted as a distance into or away from the screen.

Parameters

ScreenXYZ A point on your screen, whose 3D world coordinates you wish to know.

worldToCamera ()

ofVec3f worldToCamera(ofVec3f WorldXYZ, ofRectangle viewport=ofRectangle()) const

cameraToWorld ()

ofVec3f cameraToWorld(ofVec3f CameraXYZ, ofRectangle viewport=ofRectangle()) const

Renderer

setRenderer ()

void setRenderer(shared_ptr< ofBaseRenderer > renderer)

Constructor and Destructor

ofEasyCam ()

ofEasyCam()

Create a default camera.

~ofEasyCam ()

~ofEasyCam()

Destroy the camera.

Rendering

begin ()

void begin(ofRectangle viewport=ofRectangle())

Begins rendering with the camera.

void draw() {
    // Begin rendering from the camera's perspective.
    camera.begin();
    ofLine(0, 0, ofGetWidth(), ofGetHeight());
    // Additional rendering ...
    // End rendering form the camera's perspective.
    camera.end();
}

Parameters

viewport The camera's rendering viewport.

Reimplemented from ofCamera.

reset ()

void reset()

Reset the camera position and orientation.

Camera Target

setTarget ()

void setTarget(const ofVec3f &target)

Set the camera's target.

Parameters

target The position of the target.

void setTarget(ofNode &target)

Set the camera's target.

Parameters

target The position of the target.

getTarget ()

ofNode getTarget()

Get the camera's target node reference.

Returns: a reference the the camera's target node.

Getters

setDistance ()

void setDistance(float distance)

Set the camera's distance to the target.

Parameters

distance The distance to the target.

getDistance ()

float getDistance() const

Get the distance to the target.

Returns: the distance to the target.

setDrag ()

void setDrag(float drag)

Set the camera's drag coefficient.

Drag is affects how quickly the camera starts up and slows down when a user interacts with its position using a pointer.

Parameters

drag	The normalized coefficient value between 0 and 1.

getDrag ()

float getDrag() const

Get the camera's drag coefficient.

Returns: the camera's drag coefficient.

Setters

setAutoDistance ()

void setAutoDistance(bool bAutoDistance)

Enable or disable camera autodistance.

Allow the camera to attempt to set the distance based on the camera's current viewpoirt.

Parameters

bAutoDistance true to enable auto distance.

setEvents ()

void setEvents(ofCoreEvents &events)

setTranslationKey ()

void setTranslationKey(char key)

Set the key used to switch between camera rotation and translation.

Translation will only happen when the translation key is pressed.

Parameters

key	The key code for the translation key.

getTranslationKey ()

char getTranslationKey()

Get the current translation key code.

Returns: the current translation key code.

Mouse Input

enableMouseInput ()

void enableMouseInput()

Enable mouse camera control.

disableMouseInput ()

void disableMouseInput()

Disable mouse camera control.

getMouseInputEnabled ()

bool getMouseInputEnabled()

Determine if mouse camera control is enabled.

enableMouseMiddleButton ()

void enableMouseMiddleButton()

Enable the mouse's middle button for camera control.

disableMouseMiddleButton ()

void disableMouseMiddleButton()

Disable the mouse's middle button for camera control.

getMouseMiddleButtonEnabled ()

bool getMouseMiddleButtonEnabled()

Determine if the middle mouse button is enabled.

Parent Node

setParent ()

void setParent(ofNode &parent, bool bMaintainGlobalTransform=false)

Set parent to link nodes transformations. This will inherit transformations from parent node.

clearParent ()

void clearParent(bool bMaintainGlobalTransform=false)

Remove parent node linking.

getParent ()

ofNode getParent() const

Get the parent node that this node is linked to.

Getters

getPosition ()

ofVec3f getPosition() const

Get position as a 3d vector.

getX ()

float getX() const

Get x coordinate.

getY ()

float getY() const

Get y coordinate.

getZ ()

float getZ() const

Get z coordinate.

getXAxis ()

ofVec3f getXAxis() const

Get x axis as 3d vector.

getYAxis ()

ofVec3f getYAxis() const

Get y axis as 3d vector.

getZAxis ()

ofVec3f getZAxis() const

Get z axis as 3d vector.

getSideDir ()

ofVec3f getSideDir() const

Get x axis as 3d vector.

Returns: x axis.

getLookAtDir ()

ofVec3f getLookAtDir() const

Get -z axis as 3d vector.

Returns: -z axis.

getUpDir ()

ofVec3f getUpDir() const

Get y axis as 3d vector.

Returns: y axis.

getPitch ()

float getPitch() const

getHeading ()

float getHeading() const

getRoll ()

float getRoll() const

getOrientationQuat ()

ofQuaternion getOrientationQuat() const

getOrientationEuler ()

ofVec3f getOrientationEuler() const

getScale ()

ofVec3f getScale() const

getLocalTransformMatrix ()

ofMatrix4x4 getLocalTransformMatrix() const

getGlobalTransformMatrix ()

ofMatrix4x4 getGlobalTransformMatrix() const

getGlobalPosition ()

ofVec3f getGlobalPosition() const

getGlobalOrientation ()

ofQuaternion getGlobalOrientation() const

getGlobalScale ()

ofVec3f getGlobalScale() const

Setters

setTransformMatrix ()

void setTransformMatrix(const ofMatrix4x4 &m44)

Directly set the transformation matrix.

setPosition ()

void setPosition(float px, float py, float pz)

Set the position of the node.

void setPosition(const ofVec3f &p)

setGlobalPosition ()

void setGlobalPosition(float px, float py, float pz)

void setGlobalPosition(const ofVec3f &p)

setOrientation ()

void setOrientation(const ofQuaternion &q)

Set orientation with a quaternion.

void setOrientation(const ofVec3f &eulerAngles)

Set orientation with a euler angles.

Note: Prepare for gimbal lock

setGlobalOrientation ()

void setGlobalOrientation(const ofQuaternion &q)

setScale ()

void setScale(float s)

void setScale(float sx, float sy, float sz)

void setScale(const ofVec3f &s)

Modifiers

move ()

void move(float x, float y, float z)

Move by arbitrary amount.

void move(const ofVec3f &offset)

Move by arbitrary amount.

truck ()

void truck(float amount)

Move sideways (in local x axis)

boom ()

void boom(float amount)

Move up+down (in local y axis)

dolly ()

void dolly(float amount)

Move forward+backward (in local z axis)

tilt ()

void tilt(float degrees)

Tilt up+down (around local x axis)

pan ()

void pan(float degrees)

Rotate left+right (around local y axis)

roll ()

void roll(float degrees)

Roll left+right (around local z axis)

rotate ()

void rotate(const ofQuaternion &q)

Rotate by quaternion.

void rotate(float degrees, const ofVec3f &v)

Rotate around arbitrary axis by angle.

void rotate(float degrees, float vx, float vy, float vz)

Rotate around arbitrary axis by angle.

rotateAround ()

void rotateAround(const ofQuaternion &q, const ofVec3f &point)

Rotate by quaternion around point.

void rotateAround(float degrees, const ofVec3f &axis, const ofVec3f &point)

Rotate around arbitrary axis by angle around point.

lookAt ()

void lookAt(const ofVec3f &lookAtPosition, ofVec3f upVector=ofVec3f(0, 1, 0))

Orient node to look at position (-z axis pointing to position)

void lookAt(const ofNode &lookAtNode, const ofVec3f &upVector=ofVec3f(0, 1, 0))

Orient node to look at node (-z axis pointing to node)

orbit ()

void orbit(float longitude, float latitude, float radius, const ofVec3f ¢erPoint=ofVec3f(0, 0, 0))

Orbit object around target at radius.

void orbit(float longitude, float latitude, float radius, ofNode ¢erNode)

OpenGL Transformation

transformGL ()

void transformGL(ofBaseRenderer *renderer=ofGetCurrentRenderer().get()) const

Set opengl's modelview matrix to this nodes transform if you want to draw something at the position+orientation+scale of this node... ...call ofNode::transform(); write your draw code, and ofNode::restoreTransform(); OR A simpler way is to extend ofNode and override ofNode::customDraw();.

restoreTransformGL ()

void restoreTransformGL(ofBaseRenderer *renderer=ofGetCurrentRenderer().get()) const

resetTransform ()

void resetTransform()

Resets this node's transformation.

Drawing

customDraw ()

void customDraw(const ofBaseRenderer *renderer) const

If you extend ofNode and wish to change the way it draws, extend this try to not use global functions for rendering and instead use the passed renderer.

void customDraw()

draw ()

void draw() const

Draw function. do NOT override this transforms the node to its position+orientation+scale and calls the virtual 'customDraw' method above which you CAN override.

Reimplemented in of3dPrimitive.