ParamDef Struct Reference

#include <iparamb2.h>

Class Description

See also

Class ParamBlockDesc2, Structure PB2Value, Class PBValidator, Class PBBitmap, ParamType, ParamType2, Class ParamDimension, Template Class Tab.

Remarks

The data members of this class provide a definition of a parameter. An array of these parameter definitions is a data member of class ParamBlockDesc2.

Inheritance diagram for ParamDef:

Public Member Functions
PB2Export void	DeleteThis ()
	ParamDef ()
PB2Export bool	IsAsset () const
	Returns true if the parameter is defined as an asset. More...

Public Attributes
DWORD	size
ParamID	ID
	This is the permanent, position independent ID of the parameter. More...
const MCHAR *	int_name
	This is a fixed internal name of the parameter. More...
ParamType2	type
	This is the type of the parameter. More...
ULONGLONG	flags
	They are the per-parameter constructor flags (P_ANIMATABLE, P_TRANSIENT, etc.) Normally, the flags are set up as a result of things you specify in the ParamBlockDesc2 constructor and should generally be read-only at runtime. More...
StringResID	local_name
	This is the string table resource ID for the localized (sub-anim) name. More...
ParamDimension *	dim
	This is the parameter dimension. More...
PB2Value	def
	The default value for the parameter. More...
PB2Value	ms_def
	This is the default value for MAXScript and the MacroRecorder. More...
PB2Value	cur_def
	This is the current 'sticky' default value, used to maintain creation defaults within a session. More...
int	description
	This is a one sentence description. More...
PB2Value	range_low
	This indicates the low allowable range used in MAXScript validation and spinner setup. More...
PB2Value	range_high
	This indicates the high allowable range used in MAXScript validation and spinner setup. More...
PBValidator *	validator
	Points to an instance of the validator object. More...
PBAccessor *	accessor
	Points to an instance of an accessor object. More...
short	tab_size
	If the parameter is a table (Tab<>) this is the initial table size. More...
short	ref_no
	This is a block-owner's reference number for non-hosted ReferenceTargets parameters. More...
short	subobj_no
	This is a block-owner's SubTex index for Texmap parameters in Mtl owners. More...
Class_ID	class_ID
	This is the Class_ID validator for reference targets. More...
SClass_ID	sclass_ID
	This is the SClass_ID validator for reference targets (similar to above). More...
ControlType2	ctrl_type
	This is the type of user interface control. More...
EditSpinnerType	spin_type
	This is the spinner type if the associated UI control is a spinner. More...
int *	ctrl_IDs
	This is the array of control IDs for this parameter. More...
short	ctrl_count
	This is the number of controls in the ctrl_IDs array above. More...
union {
int *   val_bits
float *   val_bits_float
};
	These are radio button vals or bit numbers for int bits controlled by multiple checkboxes. More...
float	scale
	This is the scale given to the ISpinnerControl, as is used in SetupFloatSpinner(), for example. More...
int	numSegs
	This is the slider segments count. More...
ParamID *	enable_ctrls
	The array of which other parameters have their UI controls automatically enabled by this parameter. More...
short	enable_count
	This is the number of parameter IDs in the enable_ctrls array above. More...
int	prompt
	The status line prompt string resource ID for various picker buttons. More...
int	caption
	The caption string resource ID for open/save file dialogs. More...
int	toolTip
	The ToolTip string res ID. More...
const MCHAR *	init_file
	The initial filename for open/save file dialogs. More...
int	file_types
	The file types string resource ID for open/save file dialogs (in MAXScript type: form) More...
Tab< MapID >	maps
	Maps IDs if in a multi-map block (block flag P_MULTIMAP) More...
const MCHAR *	dyn_file_types
	A list of file types to be used for Open/Save dialogs. More...
MaxSDK::AssetManagement::AssetType	asset_type_id
	parameter type (only for TYPE_FILENAME and TYPE_FILENAME_TAB) More...

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

Constructor & Destructor Documentation

ParamDef ( )

inline

{ size = sizeof(ParamDef);}

Member Function Documentation

PB2Export void DeleteThis

(

)

Remarks

This function deletes this instance of the structure.

PB2Export bool IsAsset

(

)

const

Returns true if the parameter is defined as an asset.

A parameter is considered an asset if it's type if TYPE_FILENAME or TYPE_FILENAME_TAB and is flagged with P_HAS_ASSETTYPE or P_HAS_ASSETTYPENAME.

Member Data Documentation

DWORD size

ParamID ID

This is the permanent, position independent ID of the parameter.

const MCHAR* int_name

This is a fixed internal name of the parameter.

This name is not localized. Internal names are meant to be parsable as identifiers. As such they should begin with an alpha character, have only alphanumerics, and have no spaces, punctuations, etc. The convention for multi-word names is to use studly-caps, eg, paintRadius.

ParamType2 type

This is the type of the parameter.

See ParamType2.

ULONGLONG flags

They are the per-parameter constructor flags (P_ANIMATABLE, P_TRANSIENT, etc.) Normally, the flags are set up as a result of things you specify in the ParamBlockDesc2 constructor and should generally be read-only at runtime.

StringResID local_name

This is the string table resource ID for the localized (sub-anim) name.

ParamDimension* dim

This is the parameter dimension.

See Class ParamDimension.

PB2Value def

The default value for the parameter.

PB2Value ms_def

This is the default value for MAXScript and the MacroRecorder.

PB2Value cur_def

This is the current 'sticky' default value, used to maintain creation defaults within a session.

int description

This is a one sentence description.

Use a string resource ID.

PB2Value range_low

This indicates the low allowable range used in MAXScript validation and spinner setup.

PB2Value range_high

This indicates the high allowable range used in MAXScript validation and spinner setup.

PBValidator* validator

Points to an instance of the validator object.

This object has a Validate() method used to check if the parameter is valid.

PBAccessor* accessor

Points to an instance of an accessor object.

Any parameter in a block can have an accessor callback object that has its Get() or Set() method called whenever the parameter is accessed. This may be used to provide access to dynamically-computed virtual parameters and sometimes to allow parameter-specific processing by the class as the parameter in the block is modified.

short tab_size

If the parameter is a table (Tab<>) this is the initial table size.

short ref_no

This is a block-owner's reference number for non-hosted ReferenceTargets parameters.

short subobj_no

This is a block-owner's SubTex index for Texmap parameters in Mtl owners.

Class_ID class_ID

This is the Class_ID validator for reference targets.

SClass_ID sclass_ID

This is the SClass_ID validator for reference targets (similar to above).

ControlType2 ctrl_type

This is the type of user interface control.

EditSpinnerType spin_type

This is the spinner type if the associated UI control is a spinner.

One of the following values may be used:

• EDITTYPE_INT
  Any integer value.
• EDITTYPE_FLOAT
  Any floating point value.
• EDITTYPE_UNIVERSE
  This is a value in world space units.
  It respects the system's unit settings (for example feet and inches).
• EDITTYPE_POS_INT
  Any integer >= 0
• EDITTYPE_POS_FLOAT
  Any floating point value >= 0.0
• EDITTYPE_POS_UNIVERSE
  This is a positive value in world space units.
  It respects the system's unit settings (for example feet and inches).
• EDITTYPE_TIME
  This is a time value. It respects the system time settings (SMPTE for example).

int* ctrl_IDs

This is the array of control IDs for this parameter.

short ctrl_count

This is the number of controls in the ctrl_IDs array above.

int* val_bits

float* val_bits_float

union { ... }

These are radio button vals or bit numbers for int bits controlled by multiple checkboxes.

The numbers in the int array are used to indicate which bit to flip in the TYPE_INT parameter depending on the state of the associated (by order) checkbox. This is not yet implemented.

float scale

This is the scale given to the ISpinnerControl, as is used in SetupFloatSpinner(), for example.

int numSegs

This is the slider segments count.

ParamID* enable_ctrls

The array of which other parameters have their UI controls automatically enabled by this parameter.

short enable_count

This is the number of parameter IDs in the enable_ctrls array above.

int prompt

The status line prompt string resource ID for various picker buttons.

int caption

The caption string resource ID for open/save file dialogs.

int toolTip

The ToolTip string res ID.

const MCHAR* init_file

The initial filename for open/save file dialogs.

int file_types

The file types string resource ID for open/save file dialogs (in MAXScript type: form)

Tab<MapID> maps

Maps IDs if in a multi-map block (block flag P_MULTIMAP)

const MCHAR* dyn_file_types

A list of file types to be used for Open/Save dialogs.

MaxSDK::AssetManagement::AssetType asset_type_id

parameter type (only for TYPE_FILENAME and TYPE_FILENAME_TAB)