HProperty Class Reference

Father class for all property holder classes. More...

#include <HPropert.h>

Inheritance diagram for HProperty:

[legend]Collaboration diagram for HProperty:

[legend]List of all members.

Public Member Functions
HPropertyInfo *	GetPropertyInfo () const
HPropertyDriver *	GetHeadDriver () const
void	Show (BOOL bShow=TRUE)
void	SetNullable (BOOL isnullable)
BOOL	IsNullable ()
BOOL	IsNull ()
void	SetNull (BOOL state=TRUE, HAnimObject *animob=NULL)
void	SetIsDynamic (BOOL isdynamic)
BOOL	IsDynamic ()
HHashObject *	CreateParentForDriver ()
HProperty *	GetDriverProperty ()
void	AddDriver (HPropertyDriver *)
int	Compare (const HProperty *other, BOOL dochildren=TRUE)
BOOL	IsDefaultValue () const
int	GetIndex () const
void	Copy (const HProperty *other)
HPropertyShortcut *	FindEmptyRelation ()
HProperty *	GetPropertyCache ()
HProperty *	MakeCopy ()
String	ToString ()
BOOL	GetFirstRelationKey ()
BOOL	GetNextRelationKey ()
BOOL	GetPrevRelationKey (BOOL *pHasKey)
HProperty *	GetParentProperty ()
BOOL	IsUserProperty ()

---

Detailed Description

Father class for all property holder classes.

Classes under HProperty hold the actual property information. In other words, holds the actual values of the property. Since each instance of a plugin holds different values for the same property, the HProperty derived classes should be declared inside the instance and not inside the application as is the case for HPropertyInfo derived classes

HProperty and its derived classes are used to transfer values between the pluging application and the user interface. Hproperty derived classes only hold the value. Their UI manipulation context is supplied through an associated HPropertyInfo derived class.

Note:

In order for the HProperty derived class property to show in the property panel of the PWS, the HProperty must be assigned an index through the DLLPlugin::GetPropertyAt.

See also:

HPropertyInfo, DLLPlugin::GetPropertyAt

Definition at line 82 of file HPropert.h.

---

Member Function Documentation

void HProperty::AddDriver (  HPropertyDriver *   )

int HProperty::Compare (  const HProperty *  other, BOOL  dochildren = TRUE )

returns 0 => EQUAL, 1 => NOT EQUAL

void HProperty::Copy (  const HProperty *  other  )

HHashObject* HProperty::CreateParentForDriver (   )

HPropertyShortcut* HProperty::FindEmptyRelation (   )

HProperty* HProperty::GetDriverProperty (   )

BOOL HProperty::GetFirstRelationKey (   )

HPropertyDriver* HProperty::GetHeadDriver (   )  const

int HProperty::GetIndex (   )  const

BOOL HProperty::GetNextRelationKey (   )

HProperty* HProperty::GetParentProperty (   )

BOOL HProperty::GetPrevRelationKey (  BOOL *  pHasKey  )

HProperty* HProperty::GetPropertyCache (   )

HPropertyInfo * HProperty::GetPropertyInfo (   )  const

Retrieves the HPropertyInfo that holds all UI context information for the manipulation of the HProperty

BOOL HProperty::IsDefaultValue (   )  const

BOOL HProperty::IsDynamic (   )

BOOL HProperty::IsNull (   )

Check if the Property is set. In an Attributes set of a material for example, a property may be left unset by the user so that the model or the group property is used instead of the material property. If a particular property is left unset, then this function returns TRUE.

BOOL HProperty::IsNullable (   )

BOOL HProperty::IsUserProperty (   )

HProperty* HProperty::MakeCopy (   )

void HProperty::SetIsDynamic (  BOOL  isdynamic  )

void HProperty::SetNull (  BOOL  state = TRUE, HAnimObject *  animob = NULL )

void HProperty::SetNullable (  BOOL  isnullable  )

BOOL HProperty::Show (  BOOL  bShow = TRUE  )

Show or hide the property in the PWS property panel. It is thus possible to have invisible properties that might be used to hold computed and persistent information. Calling Show will invalidate the tree and thus force a redraw of the PWS.

String HProperty::ToString (   )

---

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

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

---