PB2Value Struct Reference

#include <iparamb2.h>

Inheritance diagram for PB2Value:

Public Member Functions
PB2Export bool	is_constant () const
	Returns FALSE if the PB2Value holds a control that is to be evaluated to get the PB2Value's value. More...
PB2Export void	Free (ParamType2 type)
	Frees the memory used by the PB2Value based on the specified type. More...
PB2Export void	Initialize (ParamType2 type)
	Initializes the memory used by the PB2Value based on the specified type. More...
PB2Export void	ReplaceString (const MCHAR *str)
	Replaces the string used by the PB2Value with the specified string. More...

Static Public Member Functions
static PB2Export bool	RequiresFree (ParamType2 type)
	Returns TRUE if the memory used by a PB2Value needs to be freed based on the specified type. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
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. More...
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. More...
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. 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 void *	operator 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...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Public Attributes
union {
int   i
	This is used by: TYPE_INT, TYPE_BOOL, TYPE_TIMEVALUE, TYPE_RADIOBTN_INDEX, TYPE_INDEX. More...
float   f
	This is used by: TYPE_FLOAT, TYPE_ANGLE, TYPE_PCNT_FRAC, TYPE_WORLD, TYPE_COLOR_CHANNEL. More...
Point2 *   p2
	This is used by: TYPE_POINT2. More...
Point3 *   p
	This is used by: TYPE_POINT3, TYPE_RGBA, TYPE_HSV. More...
Point4 *   p4
	This is used by: TYPE_POINT4, TYPE_FRGBA. More...
Matrix3 *   m
	This is used by TYPE_MATRIX3. More...
TimeValue   t
	This is used by TYPE_TIMEVALUE. More...
const MCHAR *   s
	This is used by TYPE_FILENAME or TYPE_STRING. More...
PBBitmap *   bm
	This is used by TYPE_BITMAP. More...
ReferenceTarget *   r
	A generic reference target pointer (Mtl*, Texmap*, INode*). More...
Control *   control
	This value replaces the i, f, p, p4, p2, or t values if they are actually animated (and thus have a controller assigned). More...
};
BYTE	flags
	These flags are for internal use only, do not alter them. More...

Detailed Description

See also

Class IParamBlock2, Class PBAccessor, Class PBBitmap, Class ReferenceTarget, Class Control.

Remarks

This structure holds the value in a ParamBlock2 or PBAccessor.

Member Function Documentation

is_constant()

PB2Export bool is_constant

(

)

const

Returns FALSE if the PB2Value holds a control that is to be evaluated to get the PB2Value's value.

Free()

PB2Export void Free

(

ParamType2

type

)

Frees the memory used by the PB2Value based on the specified type.

Parameters

type	The type of value held by the PB2Value.

Initialize()

PB2Export void Initialize

(

ParamType2

type

)

Initializes the memory used by the PB2Value based on the specified type.

Parameters

type	The type of value held by the PB2Value.

RequiresFree()

static PB2Export bool RequiresFree ( ParamType2  type )

static

Returns TRUE if the memory used by a PB2Value needs to be freed based on the specified type.

Parameters

type	The type of value held by a PB2Value.

ReplaceString()

PB2Export void ReplaceString

(

const MCHAR *

str

)

Replaces the string used by the PB2Value with the specified string.

Parameters

str	The new string.

Member Data Documentation

i

int i

This is used by: TYPE_INT, TYPE_BOOL, TYPE_TIMEVALUE, TYPE_RADIOBTN_INDEX, TYPE_INDEX.

f

float f

This is used by: TYPE_FLOAT, TYPE_ANGLE, TYPE_PCNT_FRAC, TYPE_WORLD, TYPE_COLOR_CHANNEL.

p2

Point2* p2

This is used by: TYPE_POINT2.

p

Point3* p

This is used by: TYPE_POINT3, TYPE_RGBA, TYPE_HSV.

p4

Point4* p4

This is used by: TYPE_POINT4, TYPE_FRGBA.

m

Matrix3* m

This is used by TYPE_MATRIX3.

Note that TYPE_MATRIX3 items cannot be animated.

t

TimeValue t

This is used by TYPE_TIMEVALUE.

s

const MCHAR* s

This is used by TYPE_FILENAME or TYPE_STRING.

bm

PBBitmap* bm

This is used by TYPE_BITMAP.

r

ReferenceTarget* r

A generic reference target pointer (Mtl*, Texmap*, INode*).

control

Control* control

This value replaces the i, f, p, p4, p2, or t values if they are actually animated (and thus have a controller assigned).

union { ... }

flags

BYTE flags

These flags are for internal use only, do not alter them.