HBhvBehaviorManager

class HBhvBehaviorManager

The HBhvBehaviorManager class stores and manages all animation related data.

The HBhvBehaviorManager class stores a list of animations, sensors and target objects and manages them on a frame by frame basis. The animation logic assumes that it will be the only logic manipulating modelling matrices for any segment that it is operating on. If such segments already have modelling matrices, they will be replaced, and this may produce unexpected results. To address this, you could have the geometric primitives in any of these segments first be transformed through the modelling matrices.

Inherits from: HTClient

Index

Methods

Variables

Methods

HBhvBehaviorManager::HBhvBehaviorManager(HBaseModel *model, int tps = 10, int delay = 0, char const *name = 0, char const *version = 0, char const *vendor = 0)

Constructs an HBhvBehaviorManager object.

Parameters

model: A pointer to HBaseModel object that this BehaviorManager object belongs to.

tps: The ticks per second value for measuring time.

delay: The initial delay for this HBhvBehaviorManager object.

name: The name of the behavior manager.

version: Additional Version Information.

vendor: Additional Vendor Information.

virtual HBhvBehaviorManager::~HBhvBehaviorManager()

virtual

void HBhvBehaviorManager::SetTicksPerSecond(int tps)

This method set the number of ticks that will occur per second.

Parameters

tps: The number of ticks per second.
int HBhvBehaviorManager::GetTicksPerSecond()

Returns

The number of ticks per second.
void HBhvBehaviorManager::Serialize(HUtilityXMLGenerator *xmlgen)

This method writes XML data to a buffer.

Parameters

xmlgen: A pointer to an XML generator that creates valid XML blocks.
void HBhvBehaviorManager::ScheduleAnimation(HBhvAnimation *animation, float currenttime)

This method schedules the given animation for immediate execution.

Parameters

animation: A pointer to the animation you want to schedule for execution

currenttime: The start time for the animation in ticks.

HBhvAnimation *HBhvBehaviorManager::AddAnimation(char const *name, char const *target, HBhvTimeline *timeline, HBhvInterpolator *interpolator)

This method creates a new animation based on given name, target, timeline and interpolator. Then it adds the new animation to the animation list.

Parameters

name: The name of the new animation.

target: A pointer to the target for the new animation.

timeline: A pointer to the timeline for the new animation.

interpolator: A pointer to the interpolator for the new animation.

Returns

A pointer to the newly created animation.
void HBhvBehaviorManager::AddAnimation(HBhvAnimation *animation)

This method adds a given animation to the animation list.

Parameters

animation: Animation to add to animation list
virtual bool HBhvBehaviorManager::Tick(float request_time, float actual_time)

virtual

The timer method that gets called from the HTManager::Tick() function. This method updates the current time and executes animations that are scheduled for the current time.

vlist_s *HBhvBehaviorManager::GetAnimationList()

Returns

A pointer to the current animation list. Note this information is for read-only purpose. To modify any information in animation list, please use the methods provided by this class.
int HBhvBehaviorManager::GetFreeName()

This utility method finds a unique animation name. This method only works if you are using an incremented naming scheme.

Returns

Unused int value indicating free name for a new animation.
void HBhvBehaviorManager::DeleteAllAnimations()

This method deletes all animations and associated objects

HBhvAnimation *HBhvBehaviorManager::FindAnimation(char const *target, char const *interpolatortype)

Searches for an animation that matches the given target string and interpolator type.

Parameters

target: The target descriptor to search for in animation instance. You can use HBhvTargetObject::CreateTargetSting() to generate this string.

interpolatortype: The interpolator type to search for in animation instance.

Returns

A pointer to the matching animation or null if no animation was found.
HBhvAnimation *HBhvBehaviorManager::FindAnimationByName(char const *name)

Searches for an animation by name.

Parameters

name: The name of the animation instance.

Returns

A pointer to the matching animation or null if no animation was found.
void HBhvBehaviorManager::ScheduleAllAnimations(bool reset = false)

Places all animations in the scheduled animation list.

void HBhvBehaviorManager::DeleteAnimation(HBhvAnimation *animation)

Removes the given animation from the animation list and then deletes it.

Parameters

animation: Pass a pointer to the animation you want to delete.
HBhvTargetObject *HBhvBehaviorManager::CreateTargetObjectByPath(char const *name, char const *path)

This method takes the given name and target and searches through the target object list. If a target object corresponding to the name and path exists, it returns that target object. If there are no matches, it creates a new one with the given name and path and adds it to the target object list.

Parameters

name: The name of the new target object.

path: The path of the new target object.

Returns

A newly created target object or an already existing target object.
void HBhvBehaviorManager::AddTargetObject(HBhvTargetObject *targetobject)

This method adds the given target object to the target object list.

Parameters

targetobject: The target object to added.
HBhvTargetObject *HBhvBehaviorManager::FindTargetObjectByName(char const *name)

This method searches the target object list for target object by name.

Parameters

name: The name of the target object.

Returns

A pointer to the target object with the given name or null if no target. object corresponding to the given name was found.
HBhvTargetObject *HBhvBehaviorManager::FindTargetObjectByPath(char const *path)

Searches for a target object given a path.

Parameters

path: The path of the target object.

Returns

A pointer to the target object with the given name or null if no target object was found.
void HBhvBehaviorManager::WriteToFile(__wchar_t const *filename)

Serializes all animation data to buffer and writes the buffer to a file.

Parameters

filename: The filename you want to create.
void HBhvBehaviorManager::WriteToFile(char const *filename)
HBaseModel *HBhvBehaviorManager::GetModel()

Returns

A pointer to the model object
void HBhvBehaviorManager::SetCurrentTickByTime(float t)

Sets the current tick based on a given time.

Parameters

t: The time in seconds.
void HBhvBehaviorManager::SetCurrentTick(float tick)

Set the current ticks. If the animation is currently playing, it will make an adjustment to m_StartTime based on the difference between old and new tick values.

Parameters

tick: The tick value.
void HBhvBehaviorManager::SetCurrentTick()

Set current tick based on current time.

float HBhvBehaviorManager::GetCurrentTick()

Returns

The current tick value.
void HBhvBehaviorManager::SetCurrentTickByPercentage(float percentage)

Calculates the current tick based on a given percentage of total length of all animations.

Parameters

percentage: The percentage value used to calculate the current tick.
float HBhvBehaviorManager::GetCurrentTickByPercentage()

Returns

The percentage value of the currrent tick in relation to the total length of all animations.
void HBhvBehaviorManager::Rewind()

Stops the execution of all animations and rewinds to the start.

bool HBhvBehaviorManager::IsPlaying()

Returns

True if animations are currently playing or false if no animations are playing.
HC_KEY HBhvBehaviorManager::GetActiveSceneKey()

Returns

The key to active scene. This key will be used for camera manipulation.
void HBhvBehaviorManager::SetActiveView(HBaseView *view)

Use this method to determine which view to apply camera manipulations.

Parameters

view: A pointer to the HBaseView object.
HBaseView *HBhvBehaviorManager::GetActiveView()

Returns

A pointer to the HBaseView object which camera manipulations will be applied to.
bool HBhvBehaviorManager::GetRenderEveryTick()

Returns

True if HOOPS will not interpolate between ticks and false if HOOPS will interpolate between ticks.
void HBhvBehaviorManager::SetRenderEveryTick(bool everytick)

Enables/disables interpolation between ticks.

Parameters

everytick: Pass true if you do not want interpolation between ticks and false if you want to interpolate between ticks.
bool HBhvBehaviorManager::GetUpdateCamera()

Returns

True if HOOPS will update camera during animation and false if HOOPS will not update camera.
bool HBhvBehaviorManager::IsAtFinalTick()

Returns

True if the current tick is greater than or equal to the last tick in the animation timeline.
void HBhvBehaviorManager::SetUpdateCamera(bool updatecamera)

Use this method to indicate if the camera should be updated during animations.

Parameters

updatecamera: Pass True to update camera or false if otherwise.
int HBhvBehaviorManager::GetNextKeyframe(int ticknum, bool forward)

Given a tick number, this method finds the next closest keyframe.

Parameters

ticknum: The tick to calculate next keyframe from.

forward: Pass true to find next closest keyframe or false to find the previous closest keyframe.

Returns

The keyframe location in tick if a keyframe is found or the given ticknum if no keyframe was found.
void HBhvBehaviorManager::AddSensor(HBhvSensor *sensor)

This method adds a given sensor to the sensor list.

Parameters

sensor: Sensor to add to sensor list.
void HBhvBehaviorManager::RemoveScheduledAnimation(HBhvAnimation *animation)

Removes the specified animation from the animation list.

Parameters

animation: A pointer to the animation that you want removed.
bool HBhvBehaviorManager::HasAnimations()

Returns

True if at least one animation exists or false if no animation exists.
int HBhvBehaviorManager::GetLastTick()

Returns

The last tick of all items in the animation list.
HBhvSensor *HBhvBehaviorManager::FindSensorByName(char const *name)

Searches for a sensor by name.

Parameters

name: The name of the sensor to search for.

Returns

A pointer to the matching sensor or null if no sensor was found.
void HBhvBehaviorManager::ExecuteAnimations(float currenttick, float starttick)

Executes all the scheduled animations.

Parameters

currenttick: The current time in ticks.

starttick: The start time in ticks. If you pass -1, currenttick will be the start time.

void HBhvBehaviorManager::SetContinuousPlay(bool cont)

Enables/disables continuous playing of the animation list. In other words, if continuous play is on, when the last tick is reached, everything is rewound and starts playing from the beginning again. Note that if infinite play is active, it will override the continuous play behavior.

Parameters

cont: Pass true to enable continuous play or false to play animations once.
void HBhvBehaviorManager::SetInfinitePlay(bool inf)

Enables/disables infinite play. If infinite play is active, then once the animation begins playing, it will continue to play pass the last tick of the timeline. This means that animations that are looped will continue to play while animations that are not looped will stop. Note that if inifinite play is active, it will override continuous play.

Parameters

inf: Pass true to set infinite play to active or false to set infinite play to inactive.
bool HBhvBehaviorManager::GetContinuousPlay()

Returns

True if the animation list loops continuously and false if the animation will only play through once and then stop. Note that if infinite play is active, it will override the continuous play behavior.
void HBhvBehaviorManager::CameraUpdated()

Use this method to indicate that camera was updated during animation.

bool HBhvBehaviorManager::GetCameraUpdated()

Returns

True if camera has been changed during animation and false if the camera has not been changed.
void HBhvBehaviorManager::Play()

Starts the execution of items on the animation list, registers with MVO timer and starts playing at the start time.

void HBhvBehaviorManager::Stop()

Pauses the execution of the items on the scheduled animation list.

void HBhvBehaviorManager::Continue()

Reactivates the execution of items on the schedule animation list.

void HBhvBehaviorManager::SetPositionMatrix(float *mat)

Sets temporary position matrix used by interpolators for camera interpolation.

Parameters

mat: The position matrix.
void HBhvBehaviorManager::GetPositionMatrix(float *mat)

Returns the position matrix used by interpolators for camera interpolation.

void HBhvBehaviorManager::SetTargetMatrix(float *mat)

Sets the temporary modelling matrix for the target object. This matrix is used by interpolators for camera interpolation.

Parameters

mat: The modelling matrix.
void HBhvBehaviorManager::GetTargetMatrix(float *mat)

Returns

The temporary modelling matrix for the target object. This matrix is used by interpolators for camera interpolation.
void HBhvBehaviorManager::SetFov(float fov)

This method has not been implemented yet.

Parameters

fov:
void HBhvBehaviorManager::GetFov(float fov)

This method has not been implemented yet.

void HBhvBehaviorManager::Reset()

Resets all animations.

void HBhvBehaviorManager::DeactivateAllAnimations()

This method deactivates all the items in the animation list. If an animation is deactivated, it can only be triggered by a sensor.

void HBhvBehaviorManager::ActivateAllAnimations()

This method activates all items on the animation list. When animations are not active, they can only be triggered by sensors.

void HBhvBehaviorManager::ActivateAnimationByName(char const *name, bool AllowPartial = true)

This method activates an animation given its partial or full name. When an animation is deactivated, it can only be triggered by a sensor.

Parameters

name: The name of the animation.

AllowPartial: Pass true if you want to allow a partial name to be used for determining animation.

void HBhvBehaviorManager::DeactivateAnimationByName(char const *name, bool AllowPartial = true)

This method deactivates an animation given its full or partial name. When an animation is deactivated, it can only be triggered by a sensor.

Parameters

name: The name of the animation.

AllowPartial: Pass true if you want to allow a partial name to be used for determining animation.

void HBhvBehaviorManager::SetStartTime(float time)

Sets the animation start time. The HBhvBehaviorManager will use this time as a referenced start time for all its calculations as it iterates through the timeline’s array of keyframes.

Parameters

time: The start time of the animation.
void HBhvBehaviorManager::SetMerge(bool merge)

Determines if loaded animation data is merged into existing animation.

Parameters

merge: Pass true if you want to merge animation data.
bool HBhvBehaviorManager::GetMerge()

Returns

True if new animation data is merged with existing animation.
HBhvAnimation *HBhvBehaviorManager::AddAnimation(char const *name, char const *targetpath, HPoint *pivot)

This method creates a new named animation.

Parameters

name: The name of the new animation

targetpath: Segment Path specifying the segment the animation should operate on

pivot: Center Point of the target (allows for off-center rotation)

Returns

Pointer to newly created Animation Object
void HBhvBehaviorManager::AddPositionKeyframe(char const *animname, int tick, HPoint pos, bool linear)

This method creates a new position keyframe for a given animation. The position keyframe allows you to specify a new position for your target object. The interpolated path can be a linear or spline movement.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

pos: 3d coordinate of keyframe

linear: Specifies if keyframe defines linear movement or spline movement

void HBhvBehaviorManager::AddQuatSquadKeyframe(char const *animname, int tick, HQuat rot, bool linear)

This method creates a new quaternion keyframe for a given animation. The quaternion key frame lets you specify a rotation for your target object.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

rot: Quaternion for keyframe

linear: Specifies if keyframe defines linear rotation or non linear rotation

void HBhvBehaviorManager::AddMatrixKeyframe(char const *animname, int tick, float matrix[])

This method creates a new matrix keyframe for a given animation. Pass a matrix that describe the rotation you want for your target object.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

matrix: matrix describing the transformation for the keyframe

void HBhvBehaviorManager::AddSegmentMoveKeyframe(char const *animname, int tick, char *path)

This method creates a new Segment Move keyframe for a given animation. The current implementation only allows one keyframe of this animation type to exist in a timeline. The segment move keyframe allows you to change the segment path of your target object.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

path: Segment path for keyframe that defines where to move segment to. The leaf segment of the path will be replaced by the name of the target segment

void HBhvBehaviorManager::AddTrailKeyframe(char const *animname, int tick, HPoint pos, bool linear, TrailInterpolatorType const *trailtype = 0, int const *weight = 0, char const *style = 0, char const *color = 0)

This method creates a new trail keyframe for a given animation. Adding a trail keyframe tells HOOPS to draw a line from the position of the previous keyframe to the position of the keyframe you are adding.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

pos: 3d coordinate of keyframe

linear: Specifies if keyframe defines linear movement or spline movement

trailtype: Trailtype for all keyframes

weight: Trail weight for all keyframes

style: Line style for all keyframes

color: Color for all keyframes

void HBhvBehaviorManager::AddAxisRotateKeyframe(char const *animname, int tick, float rot, HPoint *axis = 0)

This method creates a new Axis Rotate keyframe for a given animation. The axis rotate keyframe lets you specify the angle of rotation and axis of rotation for you target object.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

rot: Angle of rotation of keyframe

axis: Axis of rotation for all keyframes

void HBhvBehaviorManager::AddColorKeyframe(char const *animname, int tick, HPoint color, char const *colorcomponent = 0, char const *geomtype = 0)

This method creates a new color keyframe for a given animation.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

color: rgb color specification for keyframe

colorcomponent: Color component (diffuse, specular,…) for all keyframes

geomtype: Geometry Type the color applies to for all keyframes

void HBhvBehaviorManager::AddScaleKeyframe(char const *animname, int tick, HPoint scale)

This method creates a new scale keyframe for a given animation.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

pos: x/y/z/ scale values for keyframe

void HBhvBehaviorManager::AddAttributeSwitchKeyframe(char const *animname, int tick, char const *att)

This method creates a new Attribute Switch keyframe for a given animation. They attribute switch keyframes changes they attributes of your target object by giving it the specified style segment.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

att: Path to segment containing attributes for keyframe

void HBhvBehaviorManager::AddVertexMorphInterpolator(char const *animname, int tick, char const *mident, bool discrete)

This method creates a new vertex morph keyframe for a given animation. This interpolator’s behavior is described in more detail under the AddVertexMorphDataToAnimation method.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

mident: Vertex Morph Data Index

discrete: Specifies either discrete switching between morph data or interpolation for keyframe

void HBhvBehaviorManager::AddColorMorphInterpolator(char const *animname, int tick, char const *mident, bool discrete)

This method creates a new color morph keyframe for a given animation. A color morph keyframe tell HOOPS to perform an interpolation on the face colors of your target object from the previous keyframe to the new keyframe. This method in conjunction with AddColorMorphDataToAnimation.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

mident: Color Morph Data Index

discrete: Specifies either discrete switching between morph data or interpolation for keyframe

void HBhvBehaviorManager::AddSegmentSwitchKeyframe(char const *animname, int tick, char const *ss)

This method creates a new Segment Switch keyframe for a given animation. This segment switch keyframe unset the visibility of the object specified in the keyframe.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

ss: Path to segment for which visibility should be turned on for keyframe

void HBhvBehaviorManager::AddInstanceCreateKeyframe(char const *animname, int tick, char const *instance)

This method creates a new Instance Create keyframe for a given animation. This keyframe creates another instance of the target object in the segment tree specified.

Parameters

animname: The name of the animation

tick: Location of new keyframe in timeline

instance: Path to instance which should be created for keyframe

void HBhvBehaviorManager::AddVertexMorphDataToAnimation(char const *animname, HPoint *md, int pnum, HBaseModel *model, int pos = -1)

This method adds vertex morph information to a given animation. This function supplies the actual point array and associates an index to it (the first inserted point array has the index 0, the second index 1, etc) This method should be called AFTER defining the interpolator keyframe list using the AddVertexMorphInterpolator method.

Parameters

md: Pointer to morph data vertex list

pnum: Number of points in vertex list

model: Point to HBaseModel object

pos: Position to add morph data to

void HBhvBehaviorManager::AddColorMorphDataToAnimation(char const *animname, HPoint *md, int pnum, HBaseModel *model, int pos = -1)

This method adds color morph information to a given animation. This function supplies the actual point array and associates an index to it (the first inserted point array has the index 0, the second index 1, etc) This method should be called AFTER defining the interpolator keyframe list using the AddColorMorphInterpolator method.

Parameters

md: Pointer to morph data rgb color list

pnum: Number of points in rgb color list

model: Point to HBaseModel object

pos: Position to add morph data to

static void HBhvBehaviorManager::ReadFromFile(HBaseModel *model, __wchar_t const *filename)

static

Reads XML data containing animation tags from a file and loads it into memory.

Parameters

model: A pointer to the HBaseModel object.

filename: Filename

static void HBhvBehaviorManager::ReadFromFile(HBaseModel *model, char const *filename)

static

static void HBhvBehaviorManager::ProcessXMLData(HBaseModel *model, char const *buffer)

static

Sets up the XML parser to read animation related xml tags.

Parameters

model: A pointer to the model object.

buffer: A pointer to the memory buffer containing XML data.

static void *HBhvBehaviorManager::XMLCallback(HUtilityXMLTag *xt, bool open, void *m_pExtraData)

static

This is XML read callback which parses XML data and then populates the member variables with the associated values.

void HBhvBehaviorManager::ResolveInstances()

protected

This method is not yet implemented.

bool HBhvBehaviorManager::EvaluateCollision(HBhvTargetObject *tob)

protected

Determine if any collisions have occurred for specified target object.

Parameters

tob: A pointer to the target object.
HBhvInterpolator *HBhvBehaviorManager::AddKeyframe(char const *animname, char const *IntType, HKeyframe *keyframe, int tick)

protected

This method creates a new keyframe for a given animation

Parameters

animname: The name of the animation

IntType: Type of Interpolator to create/add to

keyframe: Keyframe object to add to interpolator

tick: Location of new keyframe in timeline

Variables

char HBhvBehaviorManager::m_Name[BHV_MAX_NAME_LENGTH]

protected

char

The name of the behavior manager object.

char HBhvBehaviorManager::m_Version[BHV_MAX_VERSION_LENGTH]

protected

char

The version string.

char HBhvBehaviorManager::m_Vendor[BHV_MAX_VENDOR_LENGTH]

protected

char

The additional vendor information.

int HBhvBehaviorManager::m_Tps

protected

int

The number of ticks per second.

int HBhvBehaviorManager::m_Delay

protected

int

Initial execution delay for this behaviour block

float HBhvBehaviorManager::m_StartTime

protected

float

Start of execution.

float HBhvBehaviorManager::m_CurrentTick

protected

float

The current time.

int HBhvBehaviorManager::m_LastTick

protected

int

Final tick of all animations.

struct vlist_s *HBhvBehaviorManager::m_AnimationList

protected

struct vlist_s

The list of all animations.

struct vlist_s *HBhvBehaviorManager::m_ScheduledAnimationList

protected

struct vlist_s

The list of animations scheduled for execution.

struct vlist_s *HBhvBehaviorManager::m_TargetObjectList

protected

struct vlist_s

The list of all target objects.

struct vlist_s *HBhvBehaviorManager::m_SensorList

protected

struct vlist_s

The list of all sensors.

HBaseModel *HBhvBehaviorManager::m_pModel

protected

A pointer to HBaseModel object that this behavior manager belongs to.

bool HBhvBehaviorManager::m_bPlaying

protected

bool

The value is true if animations are currently playing or false if no animation is playing.

HBaseView *HBhvBehaviorManager::m_pView

protected

A pointer to HBaseView object that is associated to this behavior manager.

bool HBhvBehaviorManager::m_bRenderEveryFrame

protected

bool

If true, HOOPS will display every frame of animations. If false, HOOPS will display animations with interpolation.

bool HBhvBehaviorManager::m_bUpdateCamera

protected

bool

The value is true if camera manipulations will be performed or false to not execute camera manipulations

bool HBhvBehaviorManager::m_bContinuousPlay

protected

bool

The value is true if the animation list will rewound and played agained whenever the timeline reaches the end or false if the animation list will be played through once and stops at the end.

bool HBhvBehaviorManager::m_bCameraUpdated

protected

bool

The value is true if camera has been changed during animation, false if camera has not been changed.

float HBhvBehaviorManager::m_positionmatrix[16]

protected

float

The temporary position matrix for interpolators.

float HBhvBehaviorManager::m_targetmatrix[16]

protected

float

The temporary target matrix for interpolators.

float HBhvBehaviorManager::m_fov

protected

float

This has not been implemented yet.

bool HBhvBehaviorManager::m_bInfinitePlay

protected

bool

The flag that determines if animation should run infinitely. In otherwords, the ticks continue to increment.

bool HBhvBehaviorManager::m_bMerge

protected

bool

The flag that determines if newly loaded animation should be merged into existing data

bool HBhvBehaviorManager::m_bShellSelectionActive

protected

bool