Graphics.Ogre.Ogre

Description

This module allows simple OGRE usage from Haskell. Note that you need OGRE libraries and headers. Tested with OGRE version 1.7.0dev-unstable (Cthugha) and 1.6.4 (Shoggoth). Usage for a simple scene creation:

Define the settings structure OgreSettings.
Define your scene by building up an OgreScene.
call initOgre with your OgreSettings as the parameter.
add your scene using addScene.
Call renderOgre in a loop.
To ensure clean shutdown, call cleanupOgre.

Synopsis

Documentation

data Vector3 Source

Constructors

Vector3
Fields x :: Float y :: Float z :: Float

Instances

Eq Vector3
Read Vector3
Show Vector3

type Angle = Float Source

data Rotation Source

Constructors

YPR
Fields yaw :: Angle pitch :: Angle roll :: Angle

Instances

Eq Rotation
Read Rotation
Show Rotation

data Color Source

Constructors

Color
Fields r :: Float g :: Float b :: Float

Instances

Eq Color
Read Color
Show Color

data TransformSpace Source

Constructors

Local
Parent
World

Instances

Enum TransformSpace
Eq TransformSpace
Read TransformSpace
Show TransformSpace

data ShadowTechnique Source

Constructors

None
StencilModulative	Note: as of 0.0.1, stencil shadows do not work when the window was created by SDL.
StencilAdditive
TextureModulative
TextureAdditive
TextureAdditiveIntegrated
TextureModulativeIntegrated

Instances

Enum ShadowTechnique
Eq ShadowTechnique
Read ShadowTechnique
Show ShadowTechnique

data Light Source

Constructors

Light
Fields lightname :: String diffuse :: Color specular :: Color lighttype :: LightType

Instances

Eq Light
Read Light
Show Light

data LightType Source

Constructors

PointLight
Fields plposition :: Vector3
DirectionalLight
Fields dldirection :: Vector3
SpotLight
Fields slposition :: Vector3 sldirection :: Vector3 range :: (Angle, Angle) Angle in radians

Instances

Eq LightType
Read LightType
Show LightType

data EntityType Source

For Plane parameters, see OGRE documentation at http://www.ogre3d.org/docs/api/html/classOgre_1_1Plane.html and Ogre::MeshManager::createPlane: http://www.ogre3d.org/docs/api/html/classOgre_1_1MeshManager.html

Constructors

StdMesh
Fields mesh :: String rotation :: Rotation
Plane
Fields normal :: Vector3 shift :: Float width :: Float height :: Float xsegments :: Int ysegments :: Int utile :: Float vtile :: Float upvector :: Vector3 material :: String

Instances

Eq EntityType
Read EntityType
Show EntityType

data Camera Source

Constructors

Camera
Fields lookat :: Vector3 camroll :: Angle camposition :: Vector3

Instances

Eq Camera
Read Camera
Show Camera

data Entity Source

Constructors

Entity
Fields name :: String Unique identifier for the entity. position :: Vector3 entitytype :: EntityType EntityType is usually a mesh. castshadows :: Bool scale :: Vector3

Instances

Eq Entity
Read Entity
Show Entity

data OgreSettings Source

General, scene-wide Ogre settings. Main configuration structure for Ogre.

Constructors

OgreSettings

Fields

resourcefile :: FilePath: Path to resources.cfg.
autocreatewindow :: Bool: Whether the window should be created automatically (by Ogre). Turn this off if the window should be created by another library (e.g.) SDL.
caption :: String: Window caption.
ambientlight :: Color
shadowtechnique :: ShadowTechnique
scenemanagertype :: [SceneManagerType]: Flags for the scene manager. Most scenes only need to set Generic as type.

Instances

Eq OgreSettings
Read OgreSettings
Show OgreSettings

data OgreScene Source

Entities and other objects that define the scene.

Constructors

OgreScene
Fields camera :: Camera entities :: [Entity] lights :: [Light]

Instances

Eq OgreScene
Read OgreScene
Show OgreScene

data SceneManagerType Source

Constructors

Generic
ExteriorClose
ExteriorFar
ExteriorRealFar
Interior

Instances

Eq SceneManagerType
Read SceneManagerType
Show SceneManagerType

halfPI :: Float Source

degToRad :: Float -> Float Source

unitX :: Vector3 Source

unitY :: Vector3 Source

unitZ :: Vector3 Source

negUnitX :: Vector3 Source

negUnitY :: Vector3 Source

negUnitZ :: Vector3 Source

initOgre :: OgreSettings -> IO ()Source

Initializes Ogre with given settings. This must be called before manipulating or rendering the scene.

addScene :: OgreScene -> IO ()Source

setupCamera :: Camera -> IO ()Source

clearScene :: IO ()Source

addLight :: Light -> IO ()Source

addEntity :: Entity -> IO ()Source

setLightPosition Source

Arguments

:: String	Name of light
-> Vector3	New position
-> IO ()

setEntityPosition Source

Arguments

:: String	Name of entity
-> Vector3	New position
-> IO ()

rotateEntity :: String -> Rotation -> TransformSpace -> IO ()Source

rotateCamera :: Rotation -> TransformSpace -> IO ()Source

translateEntity :: String -> Vector3 -> TransformSpace -> IO ()Source

translateCamera :: Vector3 -> IO ()Source

setLightVisible :: String -> Bool -> IO ()Source

setAmbientLight :: Color -> IO ()Source

setSkyDome Source

Arguments

:: Maybe (String, Float)	If Nothing, will disable sky dome. Otherwise, String refers to the material name. Float defines the curvature.
-> IO ()

See Ogre::SceneManager::setSkyDome().

setWorldGeometry :: String -> IO ()Source

See Ogre::SceneManager::setWorldGeometry().

setCameraPosition :: Vector3 -> IO ()Source

getCameraPosition :: IO Vector3 Source

raySceneQuerySimple Source

Arguments

:: Vector3	Origin of ray
-> Vector3	Direction of ray
-> IO (Maybe Vector3)	Point where ray intersects something, or Nothing if not found

Creates a ray scene query.

raySceneQueryMouseSimple Source

Arguments

:: Float	X-coordinate (width) of the ray origin on screen, between 0 (left) and 1 (right).
-> Float	Y-coordinate (height) of the ray origin on screen, between 0 (top) and 1 (bottom).
-> IO (Maybe Vector3)	Point where ray intersects something, or Nothing if not found

Creates a ray scene query based on given mouse coordinates.

renderOgre :: IO ()Source

renderOgre renders one frame.

cleanupOgre :: IO ()Source