Package org.robwork.sdurw_graphics

Class SceneCamera

java.lang.Object

org.robwork.sdurw_graphics.SceneNode

org.robwork.sdurw_graphics.SceneCamera

public class SceneCamera
extends SceneNode

Node representing a camera in the scene. A SceneCamera sets up everything
from rendering buffer to perspective transform.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SceneCamera.AspectRatioControl	Mode for aspect ratio control.

Nested classes/interfaces inherited from class org.robwork.sdurw_graphics.SceneNode

SceneNode.AddPolicy, SceneNode.NodeType

Constructor Summary

Constructors

Constructor	Description
SceneCamera(long cPtr, boolean cMemoryOwn)
SceneCamera(java.lang.String name, SceneNodePtr subGraph)	constructor

Method Summary

Modifier and Type	Method	Description
SceneCamera	asCameraNode()	Get a pointer to a CameraNode, if this is a CameraNode.
void	attachTo(SceneNodePtr snode)	Attach camera to scene node.
void	delete()
double	getAspectRatio()	Get the aspect ratio.
SceneCamera.AspectRatioControl	getAspectRatioControl()	Get current mode of aspect ratio control.
SceneNodePtr	getAttachedNode()	Get the node attached to.
int	getClearBufferMask()	get the clear buffer mask that describe which buffers are cleared before drawing
static long	getCPtr(SceneCamera obj)
int	getDrawMask()	Get the mask used when drawing in the scene
java.lang.String	getName()	get the camera name
ProjectionMatrix	getProjectionMatrix()	gets the projection matrix
SceneNodePtr	getRefNode()	get the reference node
Transform3D	getTransform()	get the camera transform
void	getViewport(SWIGTYPE_p_int x, SWIGTYPE_p_int y, SWIGTYPE_p_int width, SWIGTYPE_p_int height)	get viewport settings
boolean	isClearBufferEnabled()	test if buffers is cleared before drawing
boolean	isDepthTestEnabled()	test if depth testing is enabled
boolean	isEnabled()	test if this camera is enabled
boolean	isLightningEnabled()	test if lightning is enabled
void	setAspectRatioControl(SceneCamera.AspectRatioControl control)	Change the mode for aspect ratio control.
void	setClearBufferEnabled(boolean enabled)	set to true if the render buffer should be cleared before drawing
void	setClearBufferMask(int mask)	choose which buffers that should be cleared
void	setDepthTestEnabled(boolean enabled)	enable or disable the use of depth tests (depth buffer)
void	setDrawMask(int mask)	set the mask used when drawing in the scene
void	setEnabled(boolean enabled)	enable or disable this camera
void	setLightningEnabled(boolean enabled)	enable or disable the use of lightning
void	setPerspective(double fov, int w, int h, double zNear, double zFar)	sets the projection matrix of this camera to be a perspective projection
void	setProjectionMatrix(ProjectionMatrix matrix)	sets the current camera projection matrix
void	setRefNode(SceneNodePtr snode)	set the reference node of the camera
void	setTransform(Transform3D t3d)	set the camera transform relative to reference node (getRefNode)
void	setViewport(int x, int y, int width, int height)	set viewport settings

Methods inherited from class org.robwork.sdurw_graphics.SceneNode

addParent, addParent, asDrawableNode, asGroupNode, get_name, get_parentNodes, get_type, getCPtr, getType, hasParent, removeParent, removeParent, set_name, set_parentNodes, set_type, setName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SceneCamera

public SceneCamera(long cPtr,
                   boolean cMemoryOwn)

SceneCamera

public SceneCamera(java.lang.String name,
                   SceneNodePtr subGraph)

constructor

Parameters:

name - [in] name of camera

subGraph - [in] the root of the subgraph that this camera is supposed to render.

Method Detail

getCPtr

public static long getCPtr(SceneCamera obj)

delete

public void delete()

Overrides:

delete in class SceneNode

setPerspective

public void setPerspective(double fov,
                           int w,
                           int h,
                           double zNear,
                           double zFar)

sets the projection matrix of this camera to be a perspective projection

Parameters:

fov - [in] field of view in radians.

w - [in] view width

h - [in] view height

zNear - [in] near clipping plane

zFar - [in] far clipping plane

getProjectionMatrix

public ProjectionMatrix getProjectionMatrix()

gets the projection matrix

Returns:

the current camera projection matrix

setProjectionMatrix

public void setProjectionMatrix(ProjectionMatrix matrix)

sets the current camera projection matrix

Parameters:

matrix - [in] a projection matrix

setViewport

public void setViewport(int x,
                        int y,
                        int width,
                        int height)

set viewport settings

getViewport

public void getViewport(SWIGTYPE_p_int x,
                        SWIGTYPE_p_int y,
                        SWIGTYPE_p_int width,
                        SWIGTYPE_p_int height)

get viewport settings

setClearBufferEnabled

public void setClearBufferEnabled(boolean enabled)

set to true if the render buffer should be cleared before drawing

isClearBufferEnabled

public boolean isClearBufferEnabled()

test if buffers is cleared before drawing

setClearBufferMask

public void setClearBufferMask(int mask)

choose which buffers that should be cleared

getClearBufferMask

public int getClearBufferMask()

get the clear buffer mask that describe which buffers are cleared before drawing

setDepthTestEnabled

public void setDepthTestEnabled(boolean enabled)

enable or disable the use of depth tests (depth buffer)

isDepthTestEnabled

public boolean isDepthTestEnabled()

test if depth testing is enabled

setLightningEnabled

public void setLightningEnabled(boolean enabled)

enable or disable the use of lightning

isLightningEnabled

public boolean isLightningEnabled()

test if lightning is enabled

getRefNode

public SceneNodePtr getRefNode()

get the reference node

setRefNode

public void setRefNode(SceneNodePtr snode)

set the reference node of the camera

isEnabled

public boolean isEnabled()

test if this camera is enabled

setEnabled

public void setEnabled(boolean enabled)

enable or disable this camera

asCameraNode

public SceneCamera asCameraNode()

Description copied from class: SceneNode

Get a pointer to a CameraNode, if this is a CameraNode.

Overrides:

asCameraNode in class SceneNode

Returns:

a pointer, or NULL if the SceneNode is not of correct type.

setTransform

public void setTransform(Transform3D t3d)

set the camera transform relative to reference node (getRefNode)

getTransform

public Transform3D getTransform()

get the camera transform

setAspectRatioControl

public void setAspectRatioControl(SceneCamera.AspectRatioControl control)

Change the mode for aspect ratio control.

Parameters:

control - [in] new mode.

getAspectRatioControl

public SceneCamera.AspectRatioControl getAspectRatioControl()

Get current mode of aspect ratio control.

Returns:

the current mode.

setDrawMask

public void setDrawMask(int mask)

set the mask used when drawing in the scene

Parameters:

mask - [in] The draw mask - see DrawableNode::DrawableTypeMask.

getDrawMask

public int getDrawMask()

Get the mask used when drawing in the scene

Returns:

the draw mask - see DrawableNode::DrawableTypeMask.

getName

public java.lang.String getName()

get the camera name

Overrides:

getName in class SceneNode

Returns:

camera name

attachTo

public void attachTo(SceneNodePtr snode)

Attach camera to scene node.

Parameters:

snode - [in] node to attach to.

getAttachedNode

public SceneNodePtr getAttachedNode()

Get the node attached to.

Returns:

the node.

getAspectRatio

public double getAspectRatio()

Get the aspect ratio.

Returns:

the aspect ratio.