HObject Class Reference

An HObject is a work copy of a HObjectCache to allow modification by an Action or a Choreography. More...

#include <HObject.h>

Inheritance diagram for HObject:

Inheritance graph
[legend]
Collaboration diagram for HObject:

Collaboration graph
[legend]
List of all members.

Public Member Functions

HBoolPropertyGetActive ()
HChorGetChor ()
HActionShortcutContainerGetActionShortcutContainer ()
HRelationContainerGetRelationContainer ()
HActionGetCurrentChorAction ()
HObjectMakeCopy (BOOL insertintochor=TRUE)
void SetIsActionDeleted (BOOL bState)
BOOL IsActionDeleted ()
HAnimObjectFindAnimObjectFromCache (HAnimObject *key)

Detailed Description

An HObject is a work copy of a HObjectCache to allow modification by an Action or a Choreography.

A:M differenciates between an object that you find in the Objects folder in the PWS and references to the object that you find in Actions or Choreographies folders of the PWS for example and named "Shortcut to ...". While the actual object found in the Objects folder of the PWS is a HObjectCache or a cache for short, any "Shortcut to ..." instance is an HObject. Thus if you drop a HObjectCache into a choreography, an HObject is created, and it is added to the internal list of checked out HObject. When an object is being edited in a window, an HObject is aslo created and it is the HObject that is being displayed and edited. In other words, you must have an HModel of an HModelCache to draw it on the screen.

So the HObject or any derived classes contain a work copy of the original HObjectCache where any attributes or components may be overriden or redefined or dynamicaly recomputed according to some action performed on it at some given time. The HObjectCache will always stay unchanged while the HObject will change as the animation goes or as specific requirements of a shortcut are redefined.

See also:
HObjectCache fo a descrition of its realtion to HObject

Definition at line 27 of file HObject.h.


Member Function Documentation

HAnimObject* HObject::FindAnimObjectFromCache HAnimObject key  ) 
 

HActionShortcutContainer* HObject::GetActionShortcutContainer  ) 
 

HBoolProperty* HObject::GetActive  ) 
 

HChor* HObject::GetChor  ) 
 

HAction* HObject::GetCurrentChorAction  ) 
 

HRelationContainer* HObject::GetRelationContainer  ) 
 

BOOL HObject::IsActionDeleted  ) 
 

HObject* HObject::MakeCopy BOOL  insertintochor = TRUE  ) 
 

void HObject::SetIsActionDeleted BOOL  bState  ) 
 


The documentation for this class was generated from the following file:
This A:M SDK v12.0 documentation is maintained by Hash Inc. Please address any comments concerning this documentation to AMReports. If you have any information, knowledge, or documentation to share with the A:M developer community, please post them on the Hash SDK forum.

Generated on Thu Oct 27 11:46:56 2005 with doxygen 1.4.5 written by Dimitri van Heesch, © 1997-2001