HTreeObject Class Reference

The father class of about all objects in Animation Master. More...

#include <HHashObj.h>

Inheritance diagram for HTreeObject:

[legend]List of all members.

Public Types
enum	Skip {   SKIPNONE = 0x00, SKIPINVISIBLE = 0x01, SKIPFILTERED = 0x02, SKIPADVANCED = 0x04,   SKIPFOLDERS = 0x08 }
Public Member Functions
HProperty *	GetPropertyAt (int i)
ObjectType	GetObjectType ()
int	GetType ()
void	operator delete (void *ptr)
BOOL	IsModified ()
void	OnModified ()
HTreeObject *	FindChildByName (char *matchname)
HTreeObject *	FindChildByTreeName (char *treename)
void	ExpandInProjectBar (BOOL expand)
void	RefreshInProjectBar (BOOL updatenow=FALSE)
void	HilightInProjectBar ()
HTreeObject *	GetTreeParent (UINT skip=SKIPINVISIBLE|SKIPFILTERED)
HTreeObject *	GetTreeProgeny (UINT skip=SKIPINVISIBLE|SKIPFILTERED)
HTreeObject *	GetTreeSibling (UINT skip=SKIPINVISIBLE|SKIPFILTERED)
HTreeObject *	GetParent ()
void	SetParent (HTreeObject *parent)
void	ReassignPtr (void *ptruplink, HTreeObject *newvalue)
HAnimObject *	GetAnimObject ()
HAnimObject *	GetAnimObjectNotProperty ()
String	GetMatchName ()
String	GetFileName ()
String	GetFullName ()
HBone *	IsBone ()
BOOL	IsActionObjectChild ()
void	InterpolateObjects (Time time, BOOL notify=TRUE)
void	Interpolate (Time time, BOOL notify=TRUE)
void	OffInterpolate (HProperty *dueto)
HHashObject *	IsHashObject ()
HAnimObjectShortcut *	IsAnimObjectShortcut ()
HPropertyDriver *	IsPropertyDriver ()
BOOL	Save (HashStream &hs)
void	SetVisible (BOOL visible)
void	SetTempBit (BOOL state)
BOOL	GetTempBit ()
HProperty *	IsProperty ()
Static Public Member Functions
static void	DeleteHandle (HTreeObject *handle)

---

Detailed Description

The father class of about all objects in Animation Master.

The HTreeObject contains general functions mainly for retrieving informations about the tree node and it immediate descenants.

Definition at line 180 of file HHashObj.h.

---

Member Enumeration Documentation

enum HTreeObject::Skip

Enumerator: SKIPNONE  SKIPINVISIBLE  SKIPFILTERED  SKIPADVANCED  SKIPFOLDERS  Definition at line 200 of file HHashObj.h.

---

Member Function Documentation

static void HTreeObject::DeleteHandle (  HTreeObject *  handle  )  [static]

Referenced by HSpline::operator delete().

void HTreeObject::ExpandInProjectBar (  BOOL  expand  )

HTreeObject * HTreeObject::FindChildByName (  char *  matchname  )

Returns a pointer to an object in the PWS tree whose name match the passed argument. Usefull for finding a specific object or folder. Once an object is returned, its actual type may be retrieved with GetObjectType Examples: hac->FindChildByName("Splines"); hac->FindChildByName("Bones"); hac->FindChildByName("Untitled"); See also: HTreeObject::GetObjectType

HTreeObject* HTreeObject::FindChildByTreeName (  char *  treename  )

HAnimObject* HTreeObject::GetAnimObject (   )

Reimplemented in HAnimObjectShortcut.

HAnimObject * HTreeObject::GetAnimObjectNotProperty (   )

You can call GetAnimObjectNotProperty to get the actual object that the shader is on. The object returned by GetAnimObjectNotProperty should be either the HModelCache, HGroup, or a HCameraCache. It is safe to cast the HAnimObject returned to an HHashObject, or the prefered way, to an HTreeObject in ordet to call its GetObjectType().

String HTreeObject::GetFileName (   )

Reimplemented in HBufferShortcut, and HFileInfoProperty.

String HTreeObject::GetFullName (   )

String HTreeObject::GetMatchName (   )

ObjectType HTreeObject::GetObjectType (   )

Returns the object type See also: ObjectType for the complete list of ObjectType tags and their values. HTreeObject::GetObjectType() Reimplemented in HHashObject, and HShading.

HTreeObject * HTreeObject::GetParent (   )

Skips user containers, and doesn't include classes not derived off HashObject (CPs)

HProperty* HTreeObject::GetPropertyAt (  int  i  )

BOOL HTreeObject::GetTempBit (   )

HTreeObject * HTreeObject::GetTreeParent (  UINT  skip = SKIPINVISIBLE|SKIPFILTERED  )

Along with GetTreeProgeny and GetTreeSibling These 3 functions allow to walk the complete tree hierarchy and skip possible objects based on paramatwers passed in.

HTreeObject * HTreeObject::GetTreeProgeny (  UINT  skip = SKIPINVISIBLE|SKIPFILTERED  )

Along with GetTreeParent and GetTreeSibling These 3 functions allow to walk the complete tree hierarchy and skip possible objects based on paramatwers passed in.

HTreeObject * HTreeObject::GetTreeSibling (  UINT  skip = SKIPINVISIBLE|SKIPFILTERED  )

Along with GetTreeProgeny and GetTreeParent These 3 functions allow to walk the complete tree hierarchy and skip possible objects based on paramatwers passed in.

int HTreeObject::GetType (   )

Reimplemented in HCameraCache, and HFXCache.

void HTreeObject::HilightInProjectBar (   )

void HTreeObject::Interpolate (  Time  time, BOOL  notify = TRUE )

void HTreeObject::InterpolateObjects (  Time  time, BOOL  notify = TRUE )

BOOL HTreeObject::IsActionObjectChild (   )

HAnimObjectShortcut* HTreeObject::IsAnimObjectShortcut (   )

HBone * HTreeObject::IsBone (   )

Returns itself as an HBone if it is one, or NULL

HHashObject* HTreeObject::IsHashObject (   )

BOOL HTreeObject::IsModified (   )

HProperty* HTreeObject::IsProperty (   )

HPropertyDriver* HTreeObject::IsPropertyDriver (   )

void HTreeObject::OffInterpolate (  HProperty *  dueto  )

void HTreeObject::OnModified (   )

void HTreeObject::operator delete (  void *  ptr  )  [inline]

Reimplemented in HSpline. Definition at line 188 of file HHashObj.h.

void HTreeObject::ReassignPtr (  void *  ptruplink, HTreeObject *  newvalue )

Referenced by DLLPlugin::ReassignPtr().

void HTreeObject::RefreshInProjectBar (  BOOL  updatenow = FALSE  )

BOOL HTreeObject::Save (  HashStream &  hs  )

void HTreeObject::SetParent (  HTreeObject *  parent  )

void HTreeObject::SetTempBit (  BOOL  state  )

void HTreeObject::SetVisible (  BOOL  visible  )

---

The documentation for this class was generated from the following files:

• C:/Program Files/Hash Inc/AM120SDK/Include/SDK/HHashObj.h
• C:/Dox/SDK/Comments/PWS.dox

---