MSPluginPBAccessor Class Reference

Search for all occurrences

#include <mxsPlugin.h>

Inheritance diagram for MSPluginPBAccessor:

List of all members.

Public Member Functions
	MSPluginPBAccessor (MSPluginClass *ipc, BlockID id)
void	Set (PB2Value &v, ReferenceMaker *owner, ParamID id, int tabIndex, TimeValue t)
void	Get (PB2Value &v, ReferenceMaker *owner, ParamID id, int tabIndex, TimeValue t, Interval &valid)
BOOL	KeyFrameAtTime (ReferenceMaker *owner, ParamID id, int tabIndex, TimeValue t)
void	TabChanged (tab_changes changeCode, Tab< PB2Value > *tab, ReferenceMaker *owner, ParamID id, int tabIndex, int count)
Value *	to_value (PB2Value &v, const ParamDef &pd)
void	from_value (PB2Value &v, const ParamDef &pd, Value *val)
void	DeleteThis ()

---

Constructor & Destructor Documentation

MSPluginPBAccessor	(	MSPluginClass *	ipc,
		BlockID	id
	)

---

Member Function Documentation

void Set	(	PB2Value &	v,
		ReferenceMaker *	owner,
		ParamID	id,
		int	tabIndex,
		TimeValue	t
	)		[virtual]

Search for all occurrences

Remarks:

This method is called when the specified owner objects sets the value v. This is called just before calling SetValue() on the parameters controller, so it can take note of the value going in and change it if desired.

Parameters:

PB2Value& v

The value being set.

ReferenceMaker* owner

Points to the owner of the parameter.

ParamID id

The permanent ID of the parameter.

int tabIndex

If the parameter is a Tab<> this is the zero based index of the parameter in the table.

TimeValue t

The current time the set is taking place.

Default Implementation:

{}

Reimplemented from PBAccessor.

void Get	(	PB2Value &	v,
		ReferenceMaker *	owner,
		ParamID	id,
		int	tabIndex,
		TimeValue	t,
		Interval &	valid
	)		[virtual]

Search for all occurrences

Remarks:

This method is called when the specified owner object accesses (gets) the value v. This is called after the controller is accessed, so the current controller value is seen and can be optionally overridden in the this method. Note that the controller is accessed whenever the 3ds Max time is changed (such as a slider move) and so this method will be called each frame as this happens.

Parameters:

PB2Value& v

The value being accessed.

ReferenceMaker* owner

Points to the owner of the parameter.

ParamID id

The permanent ID of the parameter.

int tabIndex

If the parameter is a Tab<> this is the zero based index of the parameter in the table.

TimeValue t

The current time the get is taking place.

Interval &valid

The validity interval for the value.

Default Implementation:

{}

Reimplemented from PBAccessor.

BOOL KeyFrameAtTime	(	ReferenceMaker *	owner,
		ParamID	id,
		int	tabIndex,
		TimeValue	t
	)		[virtual]

Search for all occurrences

Remarks:

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. For parameters not directly hosted in the parameter block that are internally animatable, this provides a keyframe query callback so that any ParamMap2 spinners associated with these 'virtual' parameters can show keyframe status for the underlying parameter. In these cases, developers should implement this method for the parameter usually asking the underlying parameter for its keyframe state.

Parameters:

ReferenceMaker* owner

Points to the owner of the parameter.

ParamID id

The permanent ID of the parameter.

int tabIndex

TimeValue t

The current time.

Default Implementation:

{ return FALSE; }

Reimplemented from PBAccessor.

void TabChanged	(	tab_changes	changeCode,
		Tab< PB2Value > *	tab,
		ReferenceMaker *	owner,
		ParamID	id,
		int	tabIndex,
		int	count
	)		[virtual]

Search for all occurrences

Remarks:

This method is called when a Tab<> parameter has a change made to its table structure.

Parameters:

tab_changes changeCode

Describes the change that has just occurred to the Tab<> parameter. One of the following enumerations:

enum tab_changes { tab_insert, tab_append, tab_delete, tab_ref_deleted, tab_setcount, tab_sort };

Tab<PB2Value>* tab

Points to the actual Tab<> in the pblock parameter.

ReferenceMaker* owner

Points to the owner of the parameter.

ParamID id

The permanent ID of the parameter.

int tabIndex

The start index of the change (for tab_insert, tab_append, tab_delete, tab_ref_deleted)

int count

The number of elements changed (for tab_insert, tab_append, tab_delete).

Reimplemented from PBAccessor.

Value* to_value	(	PB2Value &	v,
		const ParamDef &	pd
	)

Search for all occurrences

void from_value	(	PB2Value &	v,
		const ParamDef &	pd,
		Value *	val
	)

Search for all occurrences

void DeleteThis

(

)

[virtual]

Search for all occurrences

Remarks:

This method that can be used to destroy dynamically allocated instances of this class.

Default Implementation:

{ }

Reimplemented from PBAccessor.