IParamArray Class Reference

#include <iparamb.h>

Inheritance diagram for IParamArray:

Public Member Functions
virtual BOOL	SetValue (int i, TimeValue t, float v)
virtual BOOL	SetValue (int i, TimeValue t, int v)
virtual BOOL	SetValue (int i, TimeValue t, Point3 &v)
virtual BOOL	GetValue (int i, TimeValue t, float &v, Interval &ivalid)
virtual BOOL	GetValue (int i, TimeValue t, int &v, Interval &ivalid)
virtual BOOL	GetValue (int i, TimeValue t, Point3 &v, Interval &ivalid)
template<typename T >
BOOL	GetValue (int i, TimeValue t, T &v, Interval &&valid=FOREVER)
virtual IParamBlock *	GetParamBlock ()
virtual BOOL	KeyFrameAtTime (int i, TimeValue t)

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

See also

Class IParamBlock, Class IParamMap.

Description:

This class represents a virtual array of parameters. Parameter are accessed using an integer index and GetValue() and SetValue() methods. Parameter blocks are one such implementation of this class, but it can also be useful to implement a class that abstracts non-parameter block variables. The ParamMap class uses this base class so that a ParamMap can be used to control UI for not only parameter blocks but also variables stored outside of parameter blocks. The Advanced Topics section on Parameter Maps discusses how this is done.
Default implementation of these methods are provided which simply return FALSE.

Member Function Documentation

SetValue() [1/3]

virtual BOOL SetValue ( int  i, TimeValue  t, float  v  )

inlinevirtual

Remarks

This method is called when the system needs to store a value into a variable. There are overloaded functions for each type of value to set (int, float, and Point3). Each method has three parameters. Below is the float version - the others are similar.

Parameters:

int i

This is the index into the virtual array of the value to set.

TimeValue t

This is the time at which to set the value.

float v

This is the value to set.

Returns

This is not currently used.

Reimplemented in IParamBlock.

{return FALSE;}

SetValue() [2/3]

virtual BOOL SetValue ( int  i, TimeValue  t, int  v  )

inlinevirtual

Remarks

This is the integer version of above.

Reimplemented in IParamBlock.

{return FALSE;}

SetValue() [3/3]

virtual BOOL SetValue ( int  i, TimeValue  t, Point3 &  v  )

inlinevirtual

Remarks

This is the Point3 version of above.

Reimplemented in IParamBlock.

{return FALSE;}

GetValue() [1/4]

virtual BOOL GetValue ( int  i, TimeValue  t, float &  v, Interval &  ivalid  )

inlinevirtual

Remarks

Whenever the developer needs to retrieve a value from the parameter block, the GetValue() method is used. There are overloaded functions for each type of value to retrieve (int, float, Point3, and Color). Each method has four parameters:

Parameters

i	- This is the index into the virtual array of the value to retrieve.
t	- This is the time at which to retrieve the value. For constants pass 0.
v	- This is the value to retrieve.
ivalid	- The interval into which the validity of the evaluated parameters is intersected.

Returns

If the value was retrieved TRUE is returned; otherwise FALSE is returned.

Reimplemented in IParamBlock.

{return FALSE;}

GetValue() [2/4]

virtual BOOL GetValue ( int  i, TimeValue  t, int &  v, Interval &  ivalid  )

inlinevirtual

Remarks

This is the integer version of above.

Reimplemented in IParamBlock.

{return FALSE;}

GetValue() [3/4]

virtual BOOL GetValue ( int  i, TimeValue  t, Point3 &  v, Interval &  ivalid  )

inlinevirtual

Remarks

This is the Point3 version of above.

Reimplemented in IParamBlock.

{return FALSE;}

GetValue() [4/4]

BOOL GetValue ( int  i, TimeValue  t, T &  v, Interval &&  valid = FOREVER  )

inline

{ return GetValue(i, t, v, valid); }

GetParamBlock()

virtual IParamBlock * GetParamBlock ( )

inlinevirtual

Remarks

Implemented by the System.

If the array uses a parameter block, this method will return a pointer to it, otherwise it will return NULL. Note that casting won't work because of multiple inheritance.

Returns

Returns a pointer to the parameter block if one is used; NULL otherwise.

Reimplemented in IParamBlock.

{return NULL;}

KeyFrameAtTime()

virtual BOOL KeyFrameAtTime ( int  i, TimeValue  t  )

inlinevirtual

Remarks

This method is available in release 2.0 and later only.

Checks to see if a keyframe exists for the given parameter at the given time. Returns TRUE if a keyframe exists at the specified time; otherwise FALSE.

Parameters:

int i

Zero based index of the parameter to check.

TimeValue t

The time to check.

Default Implementation:

{return FALSE;}

{return FALSE;}