ParamBlockDescID Class Reference

#include <iparamb.h>

Class Description

See also

Class ParamBlockDesc.

Description:

The parameter block descriptor describes each parameter in a parameter block. This version has an ID used to identify each parameter.

class ParamBlockDescID {



ParamType type;

UserType *user;

BOOL animatable;

DWORD id;

};

Data Members:

ParamType type

The parameter type. See ParamType and ParamType2.

UserType *user

This value is not currently used – it must always be passed as NULL.

BOOL animatable

This is a flag indicating if the parameter may be animated or not. Pass TRUE if the value may be animated and FALSE if it is constant.

DWORD id

This is an ID used to identify this parameter. This provides a solution to the problem of backwards compatibility. If you alter the parameter structure of your plug-in in the future (by adding or deleting parameters for example) previously saved 3ds Max files will be incompatible. You can however use a mechanism which uses these IDs to convert older versions to the current version. See the Advanced Topics section on Parameter Maps for more detail on how this is done. ParamID pb2_id

This is an ID used to identify this parameter in a ParamBlockDesc2. There are 2 special values for this member: -1 - This ParamBlockDesc parameter is not used in the ParamBlockDesc2 -2 - Use the 'id' member value as the ParamBlockDesc2 id. Otherwise, the value specifies the ParamBlockDesc2 parameter id that corresponds to this parameter. This member is used by function CopyParamBlock2ToParamBlock, ProcessPB2ToPB1SaveToPrevious, and ParamBlock2PLCB when copying parameters between IParamBlock and IParamBlock2 instances

Public Member Functions
	ParamBlockDescID ()
	ParamBlockDescID (ParamType type, UserType *user, BOOL animatable, DWORD id)
	ParamBlockDescID (ParamType type, UserType *user, BOOL animatable, DWORD id, ParamID pb2_id)

Public Attributes
ParamType	type
UserType *	user
BOOL	animatable
DWORD	id
ParamID	pb2_id

Constructor & Destructor Documentation

ParamBlockDescID ( )

inline

: type(TYPE_FLOAT), user(nullptr), animatable(FALSE), id(0), pb2_id(-2) {}

ParamBlockDescID ( ParamType  type, UserType *  user, BOOL  animatable, DWORD  id  )

inline

: type(type), user(user), animatable(animatable), id(id), pb2_id(-2) {}

ParamBlockDescID ( ParamType  type, UserType *  user, BOOL  animatable, DWORD  id, ParamID  pb2_id  )

inline

: type(type), user(user), animatable(animatable), id(id), pb2_id(pb2_id) {}

Member Data Documentation

ParamType type

UserType* user

BOOL animatable

DWORD id

ParamID pb2_id