Safe Haskell	Safe-Infered

HGamer3D.Bindings.Ogre.ClassEntity

Synopsis

Documentation

delete Source

Arguments

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

Default destructor.

getMesh Source

Arguments

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

Gets the MeshEntity

getNumSubEntities Source

Arguments

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

Retrieves the number of SubEntity objects making up this entity.

clone Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	newName - Name for the new entity.
-> IO HG3DClass

Clones this entity and returns a pointer to the clone. Useful method for duplicating an entity. The new entity must be given a unique name, and is not attached to the scene in any way so must be attached to a SceneNodeSceneManager::createEntity

setMaterialName Source

Arguments

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

Sets the material to use for the whole of this entity. This is a shortcut method to set all the materials for all subentities of this entity. Only use this method is you want to set the same material for all subentities or if you know there is only one. Otherwise call getSubEntity()

setMaterial Source

Arguments

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

Overridden from MovableObject

getMovableType Source

Arguments

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

getAnimationState Source

Arguments

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

For entities based on animated meshes, gets the AnimationStateYou animate an entity by updating the animation state objects. Each of these represents the current state of each animation available to the entity. The AnimationStateMesh

getAllAnimationStates Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - In case the entity is animated, this functions returns the pointer to a

For entities based on animated meshes, gets the AnimationStateYou animate an entity by updating the animation state objects. Each of these represents the current state of each animation available to the entity. The AnimationStateMesh

setDisplaySkeleton Source

Arguments

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

Returns whether or not the entity is currently displaying its skeleton.

Tells the Entity

getDisplaySkeleton Source

Arguments

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

getManualLodLevel Source

Arguments

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

Gets a pointer to the entity representing the numbered manual level of detail. The zero-based index never includes the original entity, unlike Mesh::getLodLevel

getNumManualLodLevels Source

Arguments

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

Returns the number of manual levels of detail that this entity supports. This number never includes the original entity, it is difference with Mesh::getNumLodLevels

setPolygonModeOverrideable Source

Arguments

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

Detach a MovableObject

Sets whether the polygon mode of this entire entity may be overridden by the camera detail settings.

detachObjectFromBone Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	movableName - is the name of the movable object to be detached.
-> IO HG3DClass

detachObjectFromBone2 Source

Arguments

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

Detach all MovableObjects previously attached using attachObjectToBone.

Detaches an object by pointer. Use this method to destroy a MovableObject

detachAllObjectsFromBone Source

Arguments

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

MovableObject::getBoundingRadius

getBoundingRadius Source

Arguments

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

hasEdgeList Source

Arguments

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

Overridden member from ShadowCaster.

hasSkeleton Source

Arguments

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

Returns whether or not this entity is skeletally animated.

isHardwareAnimationEnabled Source

Arguments

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

Returns whether or not hardware animation is enabled. Because fixed-function indexed vertex blending is rarely supported by existing graphics cards, hardware animation can only be done if the vertex programs in the materials used to render an entity support it. Therefore, this method will only return true if all the materials assigned to this entity have vertex programs assigned, and all those vertex programs must support 'includes_morph_animation true' if using morph animation, 'includes_pose_animation true' if using pose animation and 'includes_skeletal_animation true' if using skeletal animation.

getSoftwareAnimationRequests Source

Arguments

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

Returns the number of requests that have been made for software animation If non-zero then software animation will be performed in updateAnimation regardless of the current setting of isHardwareAnimationEnabled or any internal optimise for eliminate software animation. Requests for software animation are made by calling the addSoftwareAnimationRequest()

getSoftwareAnimationNormalsRequests Source

Arguments

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

Returns the number of requests that have been made for software animation of normals If non-zero, and getSoftwareAnimationRequests()getSoftwareAnimationRequests()addSoftwareAnimationRequest()

addSoftwareAnimationRequest Source

Arguments

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

Removes a request for software animation Calling this decrements the entity's internal counter of the number of requests for software animation. If the counter is already zero then calling this method throws an exception. The normalsAlso flag if set to true will also decrement the internal counter of number of requests for software animation of normals.

Add a request for software animation Tells the entity to perform animation calculations for skeletal/vertex animations in software, regardless of the current setting of isHardwareAnimationEnabled()removeSoftwareAnimationRequest()

removeSoftwareAnimationRequest Source

Arguments

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

Shares the SkeletonInstance with the supplied entity. Note that in order for this to work, both entities must have the same Skeleton

shareSkeletonInstanceWith Source

Arguments

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

Returns whether or not this entity is either morph or pose animated.

hasVertexAnimation Source

Arguments

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

stopSharingSkeletonInstance Source

Arguments

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

Returns whether this entity shares it's SkeltonInstance with other entity instances.

Stops sharing the SkeletonInstance with other entities.

sharesSkeletonInstance Source

Arguments

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

refreshAvailableAnimationState Source

Arguments

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

Choose which vertex data to bind to the renderer.

Updates the internal animation state set to include the latest available animations from the attached skeleton. Use this method if you manually add animations to a skeleton, or have linked the skeleton to another for animation purposes since creating this entity. If you have called getAnimationState prior to calling this method, the pointers will still remain valid.

chooseVertexDataForBinding Source

Arguments