Safe Haskell	None

HGamer3D.Bindings.Ogre.ClassCamera

Synopsis

Documentation

new Source

Arguments

:: String	name
-> HG3DClass	sm
-> IO HG3DClass

Standard constructor.

delete Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance which is going to be deleted.
-> IO ()

Returns a pointer to the SceneManager

Standard destructor.

getSceneManager Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass

setPosition Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	x
-> Float	y
-> Float	z
-> IO ()

Sets the camera's position.

setPosition2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Vec3	vec
-> IO ()

Retrieves the camera's position.

getPosition Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

move Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Vec3	vec
-> IO ()

Moves the camera's position by the vector offset provided along it's own axes (relative to orientation).

Moves the camera's position by the vector offset provided along world axes.

moveRelative Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Vec3	vec
-> IO ()

Sets the camera's direction vector. Note that the up vector for the camera will automatically be recalculated based on the current up vector (i.e. the roll will remain the same).

setDirection Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	x
-> Float	y
-> Float	z
-> IO ()

Sets the camera's direction vector.

setDirection2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Vec3	vec
-> IO ()

getDirection Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

getUp Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

Gets the camera's up vector.

getRight Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

Gets the camera's right vector.

lookAt Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Vec3	targetPoint - A vector specifying the look at point.
-> IO ()

Points the camera at a location in worldspace. This is a helper method to automatically generate the direction vector for the camera, based on it's current position and the supplied look-at point.

lookAt2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	x
-> Float	y
-> Float	z - Co-ordinates of the point to look at.
-> IO ()

Rolls the camera anticlockwise, around its local z axis.

roll Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Radians	angle
-> IO ()

Rotates the camera anticlockwise around it's local y axis.

yaw Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Radians	angle
-> IO ()

Pitches the camera up/down anticlockwise around it's local z axis.

pitch Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Radians	angle
-> IO ()

Rotate the camera around an arbitrary axis.

rotate Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Vec3	axis
-> Radians	angle
-> IO ()

Rotate the camera around an arbitrary axis using a Quaternion

rotate2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Quaternion	q
-> IO ()

Tells the camera whether to yaw around it's own local Y axis or a fixed axis of choice. This method allows you to change the yaw behaviour of the camera

setFixedYawAxis Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	useFixed - If true, the axis passed in the second parameter will always be the yaw axis no matter what the camera orientation. If false, the camera yaws around the local Y.
-> Vec3	fixedAxis - The axis to use if the first parameter is true.
-> IO ()

Returns the camera's current orientation.

getOrientation Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Quaternion

setOrientation Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Quaternion	q
-> IO ()

Gets the derived orientation of the camera, including any rotation inherited from a node attachment and reflection matrix.

Sets the camera's orientation.

getDerivedOrientation Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Quaternion

getDerivedPosition Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

Gets the derived position of the camera, including any translation inherited from a node attachment and reflection matrix.

getDerivedDirection Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

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

getDerivedUp Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

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

getDerivedRight Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

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

getRealOrientation Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Quaternion

Gets the real world orientation of the camera, including any rotation inherited from a node attachment

getRealPosition Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

Gets the real world position of the camera, including any translation inherited from a node attachment.

getRealDirection Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

Gets the real world direction vector of the camera, including any rotation inherited from a node attachment.

getRealUp Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

Gets the real world up vector of the camera, including any rotation inherited from a node attachment.

getRealRight Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

Gets the real world right vector of the camera, including any rotation inherited from a node attachment.

getMovableType Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO String

Overridden from MovableObject

setLodBias Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	factor - The factor to apply to the usual level of detail calculation. Higher values increase the detail, so 2.0 doubles the normal detail and 0.5 halves it.
-> IO ()

Returns the level-of-detail bias factor currently applied to this camera. See Camera::setLodBias

Sets the level-of-detail factor for this Camera. This method can be used to influence the overall level of detail of the scenes rendered using this camera. Various elements of the scene have level-of-detail reductions to improve rendering speed at distance; this method allows you to hint to those elements that you would like to adjust the level of detail that they would normally use (up or down). The most common use for this method is to reduce the overall level of detail used for a secondary camera used for sub viewports like rear-view mirrors etc. Note that scene elements are at liberty to ignore this setting if they choose, this is merely a hint.

getLodBias Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float

Get a pointer to the camera which should be used to determine LOD settings. Sometimes you don't want the LOD of a render to be based on the camera that's doing the rendering, you want it to be based on a different camera. A good example is when rendering shadow maps, since they will be viewed from the perspective of another camera. Therefore this method lets you associate a different camera instance to use to determine the LOD. To revert the camera to determining LOD based on itself, call this method with a pointer to itself.

setLodCamera Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	lodCam
-> IO ()

Get a pointer to the camera which should be used to determine LOD settings. If setLodCamera hasn't been called with a different camera, this method will return this.

getLodCamera Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass

Sets the viewing window inside of viewport. This method can be used to set a subset of the viewport as the rendering target.

setWindow Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	Left - Relative to Viewport - 0 corresponds to left edge, 1 - to right edge (default - 0).
-> Float	Top - Relative to Viewport - 0 corresponds to top edge, 1 - to bottom edge (default - 0).
-> Float	Right - Relative to Viewport - 0 corresponds to left edge, 1 - to right edge (default - 1).
-> Float	Bottom - Relative to Viewport - 0 corresponds to top edge, 1 - to bottom edge (default - 1).
-> IO ()

Cancel view window.

resetWindow Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO ()

Returns if a viewport window is being used.

isWindowSet Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool

getBoundingRadius Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float

Overridden from MovableObject

getAutoTrackTarget Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass

Get the auto tracking target for this camera, if any.

getAutoTrackOffset Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

Get the auto tracking offset for this camera, if it is auto tracking.

getViewport Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass

If set to true a viewport that owns this frustum will be able to recalculate the aspect ratio whenever the frustum is resized. You should set this to true only if the frustum / camera is used by one viewport at the same time. Otherwise the aspect ratio for other viewports may be wrong.

Get the last viewport which was attached to this camera. This is not guaranteed to be the only viewport which is using this camera, just the last once which was created referring to it.

setAutoAspectRatio Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	autoratio
-> IO ()

Retrieves if AutoAspectRatio is currently set or not

getAutoAspectRatio Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool

setCullingFrustum Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	frustum - Pointer to a frustum to use; this can either be a manual Frustum instance (which you can attach to scene nodes like any other MovableObject), or another camera. If you pass 0 to this method it reverts the camera to normal behaviour.
-> IO ()

Returns the custom culling frustum in use.

Tells the camera to use a separate Frustum instance to perform culling. By calling this method, you can tell the camera to perform culling against a different frustum to it's own. This is mostly useful for debug cameras that allow you to show the culling behaviour of another camera, or a manual frustum instance.

getCullingFrustum Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass

isVisible3 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Vec3	vert
-> IO (EnumFrustumPlane, Bool)	culledBy

Tests whether the given container is visible in the FrustumOtherwise, false is returned.

getWorldSpaceCorners Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

Sets the position of the near clipping plane.

Gets the world space corners of the frustum. The corners are ordered as follows: top-right near, top-left near, bottom-left near, bottom-right near, top-right far, top-left far, bottom-left far, bottom-right far.

getNearClipDistance Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float

getFarClipDistance Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float

Retrieves the distance from the frustum to the far clipping plane.

setUseRenderingDistance Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	use - True to use the rendering distance, false not to.
-> IO ()

Get whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image.

Set whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image. The default behaviour is to use it.

getUseRenderingDistance Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool

synchroniseBaseSettingsWith Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	cam
-> IO ()

Get the derived position of this frustum.

Synchronise core camera settings with another. Copies the position, orientation, clip distances, projection type, FOV, focal length and aspect ratio from another camera. Other settings like query flags, reflection etc are preserved.

getPositionForViewUpdate Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Vec3

getOrientationForViewUpdate Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Quaternion

Get the derived orientation of this frustum.

setUseMinPixelSize Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	enable
-> IO ()

Returns whether to use min display size calculations Camera::setUseMinDisplaySize

Sets whether to use min display size calculations

getUseMinPixelSize Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool

new'_ :: Ptr CChar -> HG3DClassPtr -> HG3DClassPtr -> IO ()Source

Returns an estimated ratio between a pixel and the display area it represents. For orthographic cameras this function returns the amount of meters covered by a single pixel along the vertical axis. For perspective cameras the value returned is the amount of meters covered by a single pixel per meter distance from the camera. This parameter is calculated just before the camera is rendered This parameter is used in min display size calculations.

getPixelDisplayRatio Source

Arguments