ParamBlock2PLCB Class Reference

#include <iparamb2.h>

Inheritance diagram for ParamBlock2PLCB:

Public Member Functions
	ParamBlock2PLCB (ParamVersionDesc *v, int cnt, ParamBlockDesc2 *pd, ReferenceTarget *t, int refNum)
PB2Export void	proc (ILoad *iload) override
int	Priority () override
PB2Export INT_PTR	Execute (int cmd, ULONG_PTR arg1=0, ULONG_PTR arg2=0, ULONG_PTR arg3=0) override
virtual void	proc (ILoad *iload)=0
virtual int	Priority ()
virtual INT_PTR	Execute (int cmd, ULONG_PTR arg1=0, ULONG_PTR arg2=0, ULONG_PTR arg3=0)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Public Attributes
ParamVersionDesc *	versions
int	count
ParamBlockDesc2 *	curdesc
ReferenceTarget *	targ
int	pbRefNum

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 PostLoadCallback, Class ILoad.

Description:

This is a post load call back for fixing up parameter block2s. This callback handles conversion of pre-ParamBlock2 versions of an object to a ParamBlock2 version. NOTE: this thing deletes itself when it's done.

Data Members:

All data members are public.

ParamVersionDesc* versions;

This is an array of ParamVersionDesc2s.

int count;

This is the number in the array specified above.

ParamBlockDesc2* curdesc;

This is a pointer to the current version of the description.

ReferenceTarget* targ;

This is a pointer to a reference target. This is usually the this pointer of the object.

int pbRefNum;

This is the reference index of the parameter block.

Constructor & Destructor Documentation

ParamBlock2PLCB()

ParamBlock2PLCB ( ParamVersionDesc *  v, int  cnt, ParamBlockDesc2 *  pd, ReferenceTarget *  t, int  refNum  )

inline

Remarks

Constructor. The data members are initialized to the values passed.

    { 
        versions = v; count = cnt; curdesc = pd; targ = t; pbRefNum = refNum;
    }

Member Function Documentation

proc()

PB2Export void proc ( ILoad *  iload )

overridevirtual

Remarks

This methods handles the conversion of edition 1 ParamBlocks to the new ParamBlock2s.

Parameters:

ILoad *iload

An interface for loading files.

Implements PostLoadCallback.

Priority()

int Priority ( )

inlineoverridevirtual

Remarks

This method determines the order that the various registered callbacks execute. Lower priorities are run first– allowable values {0..10}: 0 is reserved for ParamBlock2PLCB & ParamBlockPLCB. This method is overridden, for example, by the ParmBlock2 PostLoadCallbacks to return 0 so it can execute before the others.

Returns

The allowable return values are 0 to 10, with 5 being the default. 0 is reserved for ParamBlock2PLCB and ParamBlockPLCB..

Default Implementation:

{ return 5; }

Note

Custom Attributes are added to their owner objects in a Priority 6 PostLoadCallback. Object Custom Attributes and object MetaData should be expected only in PostLoadCallbacks with a Priority of 7 or lower. Custom Attributes added in PostLoadCallbacks with a higher Priority may be replaced by the Priority 6 PostLoadCallback.

PostLoadCallbacks that could cause a node evaluation should have a Priority of 7 or lower, as in the evaluation attempts to access a Custom Attribute may occur, for example in a scripted controller. If the PostLoadCallback is just doing something like data collection, it should have a Priority of 10.

PostLoadCallbacks with a priority less than 0 will be treated as 0, greater than 10 will be treated as 10.

Reimplemented from PostLoadCallback.

{ return 0; }

Execute()

PB2Export INT_PTR Execute ( int  cmd, ULONG_PTR  arg1 = 0, ULONG_PTR  arg2 = 0, ULONG_PTR  arg3 = 0  )

overridevirtual

Remarks

This is a general purpose function that allows the API to be extended in the future. The 3ds Max development team can assign new cmd numbers and continue to add functionality to this class without having to 'break' the API.

This is reserved for future use.

Parameters

cmd	The command to execute.
arg1	Optional argument 1 (defined uniquely for each cmd).
arg2	Optional argument 2.
arg3	Optional argument 3.

Returns

An integer return value (defined uniquely for each cmd).

Default Implementation:

{ return 0; }

Reimplemented from PostLoadCallback.

Member Data Documentation

versions

ParamVersionDesc* versions

count

int count

curdesc

ParamBlockDesc2* curdesc

targ

ReferenceTarget* targ

pbRefNum

int pbRefNum