Safe Haskell	None

HGamer3D.Bindings.Ogre.ClassSceneNode

Synopsis

Documentation

delete Source

Arguments

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

attachObject Source

Arguments

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

Reports the number of objects attached to this node.

Adds an instance of a scene object to this node. Scene objects can include EntityCameraLightMovableObject

numAttachedObjects Source

Arguments

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

getAttachedObject Source

Arguments

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

Retrieves a pointer to an attached object. Retrieves by object name, see alternate version to retrieve by index.

Retrieves a pointer to an attached object. Retrieves by index, see alternate version to retrieve by name. The index of an object may change as other objects are added / removed.

getAttachedObject2 Source

Arguments

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

Detaches the indexed object from this scene node. Detaches by index, see the alternate version to detach by name. Object indexes may change as other objects are added / removed.

detachObject Source

Arguments

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

Detaches an object by pointer.

detachObject2 Source

Arguments

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

Detaches the named object from this node and returns a pointer to it.

detachObject3 Source

Arguments

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

detachAllObjects Source

Arguments

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

Determines whether this node is in the scene graph, i.e. whether it's ultimate ancestor is the root scene node.

Detaches all objects attached to this node.

isInSceneGraph Source

Arguments

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

getCreator Source

Arguments

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

This method removes and destroys the named child and all of its children. Unlike removeChild, which removes a single named child from this node but does not destroy it, this method destroys the child and all of it's children. Use this if you wish to recursively destroy a node as well as detaching it from it's parent. Note that any objects attached to the nodes will be detached but will not themselves be destroyed.

Gets the creator of this scene node. This method returns the SceneManager

removeAndDestroyChild Source

Arguments

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

This method removes and destroys the child and all of its children. Unlike removeChild, which removes a single named child from this node but does not destroy it, this method destroys the child and all of it's children. Use this if you wish to recursively destroy a node as well as detaching it from it's parent. Note that any objects attached to the nodes will be detached but will not themselves be destroyed.

removeAndDestroyChild2 Source

Arguments

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

Removes and destroys all children of this node. Use this to destroy all child nodes of this node and remove them from the scene graph. Note that all objects attached to this node will be detached but will not be destroyed.

removeAndDestroyAllChildren Source

Arguments

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

Allows the showing of the node's bounding box. Use this to show or hide the bounding box of the node.

showBoundingBox Source

Arguments

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

Allows the overriding of the node's bounding box over the SceneManager's bounding box setting. Use this to override the bounding box setting of the node.

hideBoundingBox Source

Arguments

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

This allows scene managers to determine if the node's bounding box should be added to the rendering queue. Scene Managers that implement their own _findVisibleObjects will have to check this flag and then use _addBoundingBoxToQueue to add the bounding box wireframe.

getShowBoundingBox Source

Arguments

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

Creates an unnamed new SceneNode as a child of this node.

createChildSceneNode Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Vec3	translate - Initial translation offset of child relative to parent
-> Quaternion	rotate - Initial rotation relative to parent
-> IO HG3DClass

Creates a new named SceneNode as a child of this node. This creates a child node with a given name, which allows you to look the node up from the parent which holds this collection of nodes.

createChildSceneNode2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	name
-> Vec3	translate - Initial translation offset of child relative to parent
-> Quaternion	rotate - Initial rotation relative to parent
-> IO HG3DClass

Tells the node 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 node - by default, it yaws around it's own local Y axis when told to yaw with TS_LOCAL, this makes it yaw around a fixed axis. You only really need this when you're using auto tracking (see setAutoTracking, because when you're manually rotating a node you can specify the TransformSpace in which you wish to work anyway.

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 node orientation. If false, the node returns to it's default behaviour.
-> Vec3	fixedAxis - The axis to use if the first parameter is true.
-> IO ()

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

getAutoTrackTarget Source

Arguments

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

getAutoTrackOffset Source

Arguments

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

Get the auto tracking offset for this node, if the node is auto tracking.

getAutoTrackLocalDirection Source

Arguments

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

Get the auto tracking local direction for this node, if it is auto tracking.

getParentSceneNode Source

Arguments

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

Gets the parent of this SceneNode

setVisible Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	visible - Whether the objects are to be made visible or invisible
-> Bool	cascade - If true, this setting cascades into child nodes too.
-> IO ()

Inverts the visibility of all objects attached to this node. This is a shortcut to calling setVisible(!isVisible()) on the objects attached to this node, and optionally to all objects attached to child nodes.

Makes all objects attached to this node become visible / invisible. This is a shortcut to calling setVisible()

flipVisibility Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	cascade - If true, this setting cascades into child nodes too.
-> IO ()

Tells all objects attached to this node whether to display their debug information or not. This is a shortcut to calling setDebugDisplayEnabled()

setDebugDisplayEnabled Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	enabled - Whether the objects are to display debug info or not
-> Bool	cascade - If true, this setting cascades into child nodes too.
-> IO ()

delete'_ :: HG3DClassPtr -> IO ()Source

attachObject'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source

numAttachedObjects'_ :: HG3DClassPtr -> Ptr CUShort -> IO ()Source

getAttachedObject'_ :: HG3DClassPtr -> CUShort -> HG3DClassPtr -> IO ()Source

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

detachObject'_ :: HG3DClassPtr -> CUShort -> HG3DClassPtr -> IO ()Source

detachObject2'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source

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

detachAllObjects'_ :: HG3DClassPtr -> IO ()Source

isInSceneGraph'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source

getCreator'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source

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