TrackClipObject Class Reference

#include <TrackClipObject.h>

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.
+ Inheritance diagram for TrackClipObject:

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. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 

Constructor & Destructor Documentation

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

The interval of the time clip.
39 {clip = iv;}
Interval clip
Specifies the interval of time clipped.
Definition: TrackClipObject.h:26
virtual ~TrackClipObject ( )
inlinevirtual
Remarks
Destructor
41 {}

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 ( )
inlinevirtual
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;}
51 {return 0;}
virtual BOOL GetKeyVal ( int  i,
void val 
)
inlinevirtual
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;}
63 {return FALSE;}
virtual BOOL SetKeyVal ( int  i,
void val 
)
inlinevirtual
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;}
75 {return FALSE;}

Member Data Documentation

Interval clip

Specifies the interval of time clipped.