TrackClipObject Class Reference
 
 
 
TrackClipObject Class Reference

This reference page is linked to from the following overview topics: Track View.


#include <TrackClipObject.h>

Inheritance diagram for TrackClipObject:
MaxHeapOperators NoteKeyClipObject

Class Description

See also:
Class Animatable.
Description:
If a plug-in supports track view copy/paste operations this object is used. A plug-in should derive a class from this base class to store the data associated with the objects tracks, and implement the methods that identify the creator of the clip object.

Public Member Functions

virtual SClass_ID  SuperClassID ()=0
virtual Class_ID  ClassID ()=0
  TrackClipObject (Interval iv)
virtual  ~TrackClipObject ()
virtual void  DeleteThis ()=0
virtual int  NumKeys ()
virtual BOOL  GetKeyVal (int i, void *val)
virtual BOOL  SetKeyVal (int i, void *val)

Public Attributes

Interval  clip
  Specifies the interval of time clipped.

Constructor & Destructor Documentation

TrackClipObject ( Interval  iv ) [inline]
Remarks:
Constructor.
Parameters:
Interval iv

The interval of the time clip.
{clip = iv;}
virtual ~TrackClipObject ( ) [inline, virtual]
Remarks:
Destructor
{}

Member Function Documentation

virtual SClass_ID SuperClassID ( ) [pure virtual]
Remarks:
This method is used to identify the creator of the clip object by returning the SuperClassID of the creator.

Implemented in NoteKeyClipObject.

virtual Class_ID ClassID ( ) [pure virtual]
Remarks:
Returns the ClassID of the creator of the clip object.

Implemented in NoteKeyClipObject.

virtual void DeleteThis ( ) [pure virtual]
Remarks:
This method is called to delete this instance of the clip object.

Implemented in NoteKeyClipObject.

virtual int NumKeys ( ) [inline, virtual]
Remarks:
This method is available in release 2.0 and later only.

Returns the number of keys in the clip object.
Default Implementation:
{return 0;}
{return 0;}
virtual BOOL GetKeyVal ( int  i,
void *  val 
) [inline, virtual]
Remarks:
This method is available in release 2.0 and later only.

Retrieves the value of the 'i-th' key.
Parameters:
int i

Specifies the key to return.

void *val

The value of the key is stored here.
Returns:
TRUE if the value was retrieved; otherwise FALSE.
Default Implementation:
{return FALSE;}
{return FALSE;}
virtual BOOL SetKeyVal ( int  i,
void *  val 
) [inline, virtual]
Remarks:
This method is available in release 2.0 and later only.

Sets the value of the 'i-th' key.
Parameters:
int i

Specifies the key to store.

void *val

The value of the key is passed here.
Returns:
TRUE if the value was stored; otherwise FALSE.
Default Implementation:
{return FALSE;}
{return FALSE;}

Member Data Documentation

Specifies the interval of time clipped.