TTimeBased Class Reference
[Shell Interfaces]

Inheritance diagram for TTimeBased:

List of all members.

Public Member Functions
virtual MCCOMErr MCCOMAPI	QueryInterface (const MCIID &riid, void **ppvObj)
virtual boolean MCCOMAPI	IsAnimated () const
virtual void MCCOMAPI	SetAnimated (boolean animated)
virtual I3DShTimeBasedData *MCCOMAPI	GetTimeBasedDataNoAddRef ()
virtual void MCCOMAPI	InvalidateCaches (int32 itsID) const
	You should override this if your animated data generates cached data that needs to be invalidated.
MCCOMErr	MarkParamAsModified (int32 index)
boolean	CheckParamForRead (int32 index) const
void	SetApproximateParamCount (uint32 Count)
int32	SetParam (void *aParam, const int8 *itsName, int32 itsID, int32 itsType)
int32	SetParamGroup (TTimeBased *aGroup, const int8 *itsName, int32 itsID)
MCCOMErr	RemoveParams (const int32 index, const int32 count)
	WARNING: when removing params, be aware that all the following indexes will shift.
MCCOMErr	ClearParams ()
MCCOMErr	EnableParam (int32 index, boolean enable)
MCCOMErr	ChangeParamGroup (TTimeBased *aGroup, int32 index)
void	SetTimeManager (I3DShTimeManager *timeManager)
void	GetTimeManager (I3DShTimeManager **timeManager)
void	SetType (int32 itsType, const int8 *className=nil)
void	GetTweener (I3DShTweener **tweener, int32 time, int32 index) const
void	SetTweener (int32 time, int32 index, I3DShTweener *atweener)
void	CopyTimeData (ECloneMode mode, TTimeBased *dest) const
boolean	SynchWithCurrentTime (int32 index, void *privData=nil)
I3DShTimeBasedData *	GetShTimeBasedNoAddRef () const
Protected Member Functions
	TTimeBased ()
virtual	~TTimeBased ()
boolean	AreParamsRegistered () const
virtual void	RegisterParams ()
virtual void	SelfSynchWithCurrentTime (int32 index, void *privData)
Protected Attributes
TMCCountedPtr< I3DShTimeBasedData >	fTimeBasedData
Private Member Functions
void	SafeRegisterParams ()
Private Attributes
boolean	fParamsRegistered

---

Detailed Description

Implementation of an animated object.

See also:

ITimeBased

---

Constructor & Destructor Documentation

TTimeBased::TTimeBased (   )  [protected]

virtual TTimeBased::~TTimeBased (   )  [protected, virtual]

---

Member Function Documentation

boolean TTimeBased::AreParamsRegistered (   )  const [inline, protected]

MCCOMErr TTimeBased::ChangeParamGroup (  TTimeBased *  aGroup, int32  index )

MCCOMErr TTimeBased::ClearParams (   )

void TTimeBased::CopyTimeData (  ECloneMode  mode, TTimeBased *  dest )  const

MCCOMErr TTimeBased::EnableParam (  int32  index, boolean  enable )

I3DShTimeBasedData* TTimeBased::GetShTimeBasedNoAddRef (   )  const [inline]

virtual I3DShTimeBasedData* MCCOMAPI TTimeBased::GetTimeBasedDataNoAddRef (   )  [virtual]

Implements ITimeBased.

void TTimeBased::GetTimeManager (  I3DShTimeManager **  timeManager  )

void TTimeBased::GetTweener (  I3DShTweener **  tweener, int32  time, int32  index )  const

virtual void MCCOMAPI TTimeBased::InvalidateCaches (  int32  itsID  )  const [virtual]

You should override this if your animated data generates cached data that needs to be invalidated. Implements ITimeBased.

virtual boolean MCCOMAPI TTimeBased::IsAnimated (   )  const [virtual]

Implements ITimeBased.

MCCOMErr TTimeBased::MarkParamAsModified (  int32  index  )

virtual MCCOMErr MCCOMAPI TTimeBased::QueryInterface (  const MCIID &  riid, void **  ppvObj )  [virtual]

Check if the object supports a given interface and returns a pointer to that interface if it does. Note that QueryInterface will increment the reference count of the object by one if the interface is found. Parameters: riid  GUID of the interface ppvObj  A pointer to the pointer being returned. Implements IMCUnknown. Reimplemented in TCountedTimeBased.

virtual void TTimeBased::RegisterParams (   )  [protected, virtual]

Reimplemented in TTimeBasedList.

MCCOMErr TTimeBased::RemoveParams (  const int32  index, const int32  count )

WARNING: when removing params, be aware that all the following indexes will shift.

void TTimeBased::SafeRegisterParams (   )  [inline, private]

virtual void TTimeBased::SelfSynchWithCurrentTime (  int32  index, void *  privData )  [protected, virtual]

virtual void MCCOMAPI TTimeBased::SetAnimated (  boolean  animated  )  [virtual]

Implements ITimeBased.

void TTimeBased::SetApproximateParamCount (  uint32  Count  )

int32 TTimeBased::SetParam (  void *  aParam, const int8 *  itsName, int32  itsID, int32  itsType )

int32 TTimeBased::SetParamGroup (  TTimeBased *  aGroup, const int8 *  itsName, int32  itsID )

void TTimeBased::SetTimeManager (  I3DShTimeManager *  timeManager  )

void TTimeBased::SetTweener (  int32  time, int32  index, I3DShTweener *  atweener )

void TTimeBased::SetType (  int32  itsType, const int8 *  className = nil )

boolean TTimeBased::SynchWithCurrentTime (  int32  index, void *  privData = nil )  [inline]

---

Member Data Documentation

boolean TTimeBased::fParamsRegistered [private]

TMCCountedPtr<I3DShTimeBasedData> TTimeBased::fTimeBasedData [protected]

---

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

• AnimUtilities.h

---