HGamer3D.Bindings.Ogre.ClassMovableObject

Documentation

delete

Arguments

:: HG3DClass

classpointer - pointer of Class instance which is going to be deleted.

-> IO ()

Virtual destructor - read Scott Meyers if you don't know why this is needed.

getName

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO String

Returns the name of this object.

getMovableType

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO String

Returns the type name of this object.

getParentNode

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO HG3DClass

Returns the node to which this object is attached. A MovableObjectSceneNodeNode

getParentSceneNode

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO HG3DClass

Returns the scene node to which this object is attached. A MovableObjectSceneNode

isParentTagPoint

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

Gets whether the parent node is a TagPoint (or a SceneNode

isAttached

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

Returns true if this object is attached to a SceneNode

detachFromParent

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Returns true if this object is attached to a SceneNodeSceneNode

Detaches an object from a parent SceneNode

isInScene

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

getBoundingRadius

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Float

Retrieves the radius of the origin-centered bounding sphere for this object.

setVisible

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

visible

-> IO ()

Gets this object whether to be visible or not, if it has a renderable component. Returns the value set by MovableObject::setVisible

Tells this object whether to be visible or not, if it has a renderable component. An alternative approach of making an object invisible is to detach it from it's SceneNodeSceneNode

getVisible

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

isVisible

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

Returns whether or not this object is supposed to be visible or not. Takes into account both upper rendering distance and visible flag.

setRenderingDistance

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Float

dist - Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered).

-> IO ()

Gets the distance at which batches are no longer rendered.

Sets the distance at which the object is no longer rendered.

getRenderingDistance

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Float

setQueryFlags

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

flags

-> IO ()

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

Sets the query flags for this object. When performing a scene query, this object will be included or excluded according to flags on the object and flags on the query. This is a bitwise value, so only when a bit on these flags is set, will it be included in a query asking for that flag. The meaning of the bits is application-specific.

addQueryFlags

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

flags

-> IO ()

As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

removeQueryFlags

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

flags

-> IO ()

Returns the query flags relevant for this object.

getQueryFlags

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

setVisibilityFlags

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

flags

-> IO ()

As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.

Sets the visiblity flags for this object. As well as a simple true/false value for visibility (as seen in setVisible), you can also set visiblity flags which when anded with the SceneManager

addVisibilityFlags

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

flags

-> IO ()

As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.

removeVisibilityFlags

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

flags

-> IO ()

Returns the visibility flags relevant for this object.

getVisibilityFlags

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

getLightMask

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

Get a bitwise mask which will filter the lights affecting this object By default, this mask is fully set meaning all lights will affect this object

setLightMask

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

lightMask

-> IO ()

Define a default implementation of method from ShadowCaster which implements no shadows.

Set a bitwise mask which will filter the lights affecting this object This mask will be compared against the mask held against Light

hasEdgeList

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

setCastShadows

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

enabled

-> IO ()

Returns whether shadow casting is enabled for this object.

Sets whether or not this object will cast shadows. This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechniqueThis method normally refers to objects which block the light, but since LightMovableObject

getCastShadows

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

getReceivesShadows

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

Returns whether the MaterialRenderableMovableObject

getPointExtrusionDistance

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> HG3DClass

l

-> IO Float

Get the distance to extrude for a point/spot light

getTypeFlags

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

Get the 'type flags' for this MovableObjectA type flag identifies the type of the MovableObjectMovableObjectFactoryMovableObjectFactoryMovableObjectFactory

setDebugDisplayEnabled

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

enabled

-> IO ()

Gets whether debug display of this object is enabled.

Sets whether or not the debug display of this object is enabled. Some objects aren't visible themselves but it can be useful to display a debug representation of them. Or, objects may have an additional debug display on top of their regular display. This option enables / disables that debug display. Objects that are not visible never display debug geometry regardless of this setting.

isDebugDisplayEnabled

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

setDefaultQueryFlags

Arguments

:: Int

flags

-> IO ()

Get the default query flags for all future MovableObject

Set the default query flags for all future MovableObject

getDefaultQueryFlags

Arguments

:: IO Int

setDefaultVisibilityFlags

Arguments

:: Int

flags

-> IO ()

Get the default visibility flags for all future MovableObject

Set the default visibility flags for all future MovableObject

getDefaultVisibilityFlags

Arguments

:: IO Int

delete'_ :: HG3DClassPtr -> IO ()

getName'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

getMovableType'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

getParentNode'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()

getParentSceneNode'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()

isParentTagPoint'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

isAttached'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

detachFromParent'_ :: HG3DClassPtr -> IO ()

isInScene'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getBoundingRadius'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()

setVisible'_ :: HG3DClassPtr -> CInt -> IO ()

getVisible'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

isVisible'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setRenderingDistance'_ :: HG3DClassPtr -> CFloat -> IO ()

getRenderingDistance'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()

setQueryFlags'_ :: HG3DClassPtr -> CUInt -> IO ()

addQueryFlags'_ :: HG3DClassPtr -> CUInt -> IO ()

removeQueryFlags'_ :: HG3DClassPtr -> CUInt -> IO ()

getQueryFlags'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()

setVisibilityFlags'_ :: HG3DClassPtr -> CUInt -> IO ()

addVisibilityFlags'_ :: HG3DClassPtr -> CUInt -> IO ()

removeVisibilityFlags'_ :: HG3DClassPtr -> CUInt -> IO ()

getVisibilityFlags'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()

getLightMask'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()

setLightMask'_ :: HG3DClassPtr -> CUInt -> IO ()

hasEdgeList'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setCastShadows'_ :: HG3DClassPtr -> CInt -> IO ()

getCastShadows'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getReceivesShadows'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getPointExtrusionDistance'_ :: HG3DClassPtr -> HG3DClassPtr -> Ptr CFloat -> IO ()

getTypeFlags'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()

setDebugDisplayEnabled'_ :: HG3DClassPtr -> CInt -> IO ()

isDebugDisplayEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setDefaultQueryFlags'_ :: CUInt -> IO ()

getDefaultQueryFlags'_ :: Ptr CUInt -> IO ()

setDefaultVisibilityFlags'_ :: CUInt -> IO ()

getDefaultVisibilityFlags'_ :: Ptr CUInt -> IO ()