This reference page is linked to from the following overview topics: Creating Parameter Blocks, Lesson 6: Parameter Blocks, Parameter Block Versioning, Extending Render To Texture to Support New Materials, Overview: Parameter Blocks, General Best Practices, Getting and Setting Parameter Block Version, Supporting Save to Previous, Parameter Specification Arguments, Parameter Tags, Parameter Block UI, Action Interfaces, Creating a Parameter Block, Describing a Parameter Block, Parameter Block Flags, Using Multiple Roll-ups, Parameter Block UI Specification Arguments, Multiple Parameter Blocks, ParamBlockDesc2 Flags, Handling Mouse Procedures.
#include <iparamb2.h>
Classes |
|
struct | map_spec |
Public Member Functions |
|
ParamBlockDesc2 () | |
PB2Export | ParamBlockDesc2 (BlockID ID, const MCHAR *int_name, StringResID local_name, ClassDesc2 *cd, USHORT flags,...) |
PB2Export | ~ParamBlockDesc2 () |
PB2Export void | AddParam (ParamID id,...) |
PB2Export void | ReplaceParam (ParamID id,...) |
PB2Export void | DeleteParam (ParamID id) |
PB2Export void | ParamOption (ParamID id, int option_tag,...) |
PB2Export bool | ParamOptionEnableCtrls (ParamID pID, const Tab< ParamID > &dependentPIDs) |
Modifies the list of controls enabled by a
certain control This method allows to modify the list of controls
that are enabled/disabled by a given control that represents a
boolean parameter. |
|
PB2Export bool | ParamOptionContentValues (ParamID id, Tab< int > &stringItems, Tab< int > *stringItemValues=NULL) |
This method is used for modifying a
descriptor incrementally. |
|
PB2Export void | SetClassDesc (ClassDesc2 *cd) |
USHORT | Count () |
DWORD | Version () |
PB2Export int | IDtoIndex (ParamID id) |
PB2Export int | NameToIndex (const MCHAR *name) |
ParamID | IndextoID (int i) |
ParamDef & | GetParamDef (ParamID id) |
BOOL | SetValue (ParamID id, TimeValue t, float v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, int v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, Point3 &v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, Point4 &v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, Color &v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, AColor &v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, const MCHAR *v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, Mtl *v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, Texmap *v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, PBBitmap *v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, INode *v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, ReferenceTarget *v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, IParamBlock2 *v, int tabIndex=0) |
BOOL | SetValue (ParamID id, TimeValue t, Matrix3 &v, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, float &v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, int &v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, Point3 &v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, Point4 &v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, Color &v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, AColor &v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, const MCHAR *&v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, Mtl *&v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, Texmap *&v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, PBBitmap *&v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, INode *&v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, ReferenceTarget *&v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, IParamBlock2 *&v, Interval &ivalid, int tabIndex=0) |
BOOL | GetValue (ParamID id, TimeValue t, Matrix3 &v, Interval &ivalid, int tabIndex=0) |
PB2Export Color | GetColor (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export AColor | GetAColor (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export Point3 | GetPoint3 (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export Point4 | GetPoint4 (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export int | GetInt (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export float | GetFloat (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export TimeValue | GetTimeValue (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export const MCHAR * | GetStr (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export Mtl * | GetMtl (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export Texmap * | GetTexmap (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export PBBitmap * | GetBitmap (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export INode * | GetINode (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export ReferenceTarget * | GetReferenceTarget (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export IParamBlock2 * | GetParamBlock2 (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export Matrix3 | GetMatrix3 (ParamID id, TimeValue t=0, int tabIndex=0) |
PB2Export const MCHAR * | GetString (StringResID id) |
PB2Export void | InvalidateUI () |
PB2Export void | InvalidateUI (ParamID id, int tabIndex=-1) |
PB2Export void | SetUserDlgProc (MapID map_id, ParamMap2UserDlgProc *proc=NULL) |
void | SetUserDlgProc (ParamMap2UserDlgProc *proc=NULL) |
PB2Export ParamMap2UserDlgProc * | GetUserDlgProc (MapID id=0) |
PB2Export void | SetOwnerRefNo (ParamID id, int refno) |
PB2Export int | GetOwnerRefNo (ParamID id) |
PB2Export void | SetSubTexNo (ParamID id, int texno) |
PB2Export void | SetSubMtlNo (ParamID id, int mtlno) |
PB2Export int | GetSubTexNo (ParamID id) |
PB2Export int | GetSubMtlNo (ParamID id) |
PB2Export void | SetInitFile (ParamID id, const MCHAR *s) |
PB2Export const MCHAR * | GetInitFile (ParamID id) |
PB2Export void | AddInterface (BaseInterface *iface) |
Adds an interface to the descriptor's
BaseInterfaceServer
interfaces list. |
|
PB2Export void | RemoveInterface (BaseInterface *iface) |
Removes an interface from the descriptor's
BaseInterfaceServer
interfaces list. |
|
PB2Export void | SetFileTypes (ParamID id, const MCHAR *fileType) |
Allows a custom filter list to be supplied
to the File dialog routines. |
|
Public Attributes |
|
ParamDef * | paramdefs |
ClassDesc2 * | cd |
const MCHAR * | int_name |
StringResID | local_name |
BlockID | ID |
USHORT | count |
ULONG | version |
USHORT | flags |
int | ref_no |
int | dlg_template |
int | title |
int | test_flags |
int | rollup_flags |
ParamMap2UserDlgProc * | dlgProc |
int | category |
Tab< map_spec > | map_specs |
MSPluginClass * | pc |
Rollout * | rollout |
IParamBlock2 * | class_params |
ParamBlockDesc2 | ( | ) |
PB2Export ParamBlockDesc2 | ( | BlockID | ID, |
const MCHAR * | int_name, | ||
StringResID | local_name, | ||
ClassDesc2 * | cd, | ||
USHORT | flags, | ||
... | |||
) |
ParamBlockDesc2 ( <required_block_specs> , [<version_number> ,] [<auto_construct_block_refno> ,] [<auto_ui_parammap_specs> ,] {<required_param_specs> , {<optional_tagged_param_specs> ,} end ,} end);
void ParamBlockDesc2::SetClassDesc(ClassDesc2*
cd);
static ParamBlockDesc2 std2_shader_blk ( std2_shader, _M("shaderParameters"), 0, &stdmtl2CD, P_AUTO_CONSTRUCT + P_AUTO_UI + P_HASCATEGORY, SHADER_PB_REF, //rollout IDD_DMTL_SHADER4, IDS_KE_SHADER, 0, 0, &shaderDlgProc, 4900, // params std2_shader_type, _M("shaderType"), TYPE_INT, 0, IDS_JW_SHADERTYPE,
static ParamBlockDesc2 metal2_param_blk ( shdr_params, _M("shaderParameters"), 0, &metalCD, P_AUTO_CONSTRUCT + P_USE_PARAMS, // pblock refno 0, // use params from existing descriptor &const_param_blk );
enum { geo_map_1, geo_map_2 }; // enum IDs for the 2 parammaps static ParamBlockDesc2 geo_param_blk ( geo_params, _M("GeosphereParameters"), 0, &gsphereDesc, P_AUTO_CONSTRUCT + P_AUTO_UI + P_MULTIMAP, PBLOCK_REF_NO, // map rollups 2, geo_map_1, IDD_GSPHERE_1, IDS_PARAMETERS_1, 0, 0, NULL, geo_map_2, IDD_GSPHERE_2, IDS_PARAMETERS_2, 0, 0, NULL, // params geo_hemi, _M("hemisphere"), TYPE_BOOL, P_ANIMATABLE, IDS_HEMI, p_default, FALSE, p_ui, geo_map_2, TYPE_SINGLECHEKBOX, IDC_HEMI, end, geo_segs, _M("segs"), TYPE_INT, P_ANIMATABLE, IDS_RB_SEGS, p_default, 4, p_range, MIN_SEGMENTS, MAX_SEGMENTS, p_ui, geo_map_1, TYPE_SPINNER, EDITTYPE_INT, IDC_SEGMENTS, IDC_SEGSPINNER, 0.05f, end, geo_radius, _M("radius"), TYPE_FLOAT, P_ANIMATABLE + P_RESET_DEFAULT, IDS_RB_RADIUS, p_default, 0.0, p_ms_default, 25.0, p_range, MIN_RADIUS, MAX_RADIUS, p_ui, geo_map_1, TYPE_SPINNER, EDITTYPE_UNIVERSE, IDC_RADIUS, IDC_RADSPINNER, 1.0, p_uix, geo_map_2, end, //...
int dialog_template_ID, int dialog_title_res_ID, int flag_mask, int rollup_flags, ParamMap2UserDlgProc* proc
ParamID id, MCHAR* internal_name, ParamType type, [int table_size,] int flags, int local_name_res_ID,
PB2Export ~ParamBlockDesc2 | ( | ) |
PB2Export void AddParam | ( | ParamID | id, |
... | |||
) |
PB2Export void ReplaceParam | ( | ParamID | id, |
... | |||
) |
PB2Export void DeleteParam | ( | ParamID | id | ) |
PB2Export void ParamOption | ( | ParamID | id, |
int | option_tag, | ||
... | |||
) |
Modifies the list of controls enabled by a certain control This method allows to modify the list of controls that are enabled/disabled by a given control that represents a boolean parameter.
Any existent list of dependent controls are replaced.
PB2Export bool ParamOptionContentValues | ( | ParamID | id, |
Tab< int > & | stringItems, | ||
Tab< int > * | stringItemValues =
NULL |
||
) |
This method is used for modifying a descriptor incrementally.
It allows for specifying the content of certain controls such as list and combo boxes by supplying a list of string resource ids. This method alters a parameter definition optional information tag of an existing descriptor. Note: You must not modify a descriptor with this method once it has been used to construct a ParamBlock2.
id | - The permanent ID of the parameter to be modified |
stringItems | - Resource ids of the strings that represent the user visible values for this parameters |
stringItemValues | - Optional list of integer values to be associated with the corresponding item in the stringItems parameter. If this parameter is not specified, the items in stringItems will be associated with their zero based index. |
PB2Export void SetClassDesc | ( | ClassDesc2 * | cd | ) |
USHORT Count | ( | ) | [inline] |
{ return count; }
DWORD Version | ( | void | ) | [inline] |
PB2Export int IDtoIndex | ( | ParamID | id | ) |
PB2Export int NameToIndex | ( | const MCHAR * | name | ) |
ParamID IndextoID | ( | int | i | ) | [inline] |
{ return class_params->SetValue(id, t, v, tabIndex); }
{ return class_params->SetValue(id, t, v, tabIndex); }
{ return class_params->SetValue(id, t, v, tabIndex); }
{ return class_params->SetValue(id, t, v, tabIndex); }
{ return class_params->SetValue(id, t, v, tabIndex); } // uses Point3 controller
{ return class_params->SetValue(id, t, v, tabIndex); } // uses Point4 controller
{ return class_params->SetValue(id, t, v, tabIndex); }
{ return class_params->SetValue(id, t, v, tabIndex); }
{ return class_params->SetValue(id, t, v, tabIndex); }
{ return class_params->SetValue(id, t, v, tabIndex); }
{ return class_params->SetValue(id, t, v, tabIndex); }
BOOL SetValue | ( | ParamID | id, |
TimeValue | t, | ||
ReferenceTarget * | v, | ||
int | tabIndex = 0 |
||
) | [inline] |
{ return class_params->SetValue(id, t, v, tabIndex); }
BOOL SetValue | ( | ParamID | id, |
TimeValue | t, | ||
IParamBlock2 * | v, | ||
int | tabIndex = 0 |
||
) | [inline] |
{ return class_params->SetValue(id, t, v, tabIndex); }
{ return class_params->SetValue(id, t, v, tabIndex); }
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
const MCHAR *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [inline] |
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
Texmap *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [inline] |
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
PBBitmap *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [inline] |
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
ReferenceTarget *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [inline] |
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
IParamBlock2 *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [inline] |
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
Matrix3 & | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [inline] |
{ return class_params->GetValue(id, t, v, ivalid, tabIndex); }
PB2Export ReferenceTarget* GetReferenceTarget | ( | ParamID | id, |
TimeValue | t = 0 , |
||
int | tabIndex = 0 |
||
) |
PB2Export IParamBlock2* GetParamBlock2 | ( | ParamID | id, |
TimeValue | t = 0 , |
||
int | tabIndex = 0 |
||
) |
PB2Export const MCHAR* GetString | ( | StringResID | id | ) | [inline] |
{ return cd->GetRsrcString(id); }
PB2Export void InvalidateUI | ( | ) | [inline] |
{ cd->InvalidateUI(this); }
PB2Export void InvalidateUI | ( | ParamID | id, |
int | tabIndex =
-1 |
||
) | [inline] |
{ cd->InvalidateUI(this, id, tabIndex); } // nominated param
PB2Export void SetUserDlgProc | ( | MapID | map_id, |
ParamMap2UserDlgProc * | proc = NULL |
||
) |
void SetUserDlgProc | ( | ParamMap2UserDlgProc * | proc = NULL |
) | [inline] |
{ SetUserDlgProc(0, proc); }
PB2Export ParamMap2UserDlgProc* GetUserDlgProc | ( | MapID | id = 0 |
) |
PB2Export void SetOwnerRefNo | ( | ParamID | id, |
int | refno | ||
) |
PB2Export int GetOwnerRefNo | ( | ParamID | id | ) |
PB2Export void SetSubTexNo | ( | ParamID | id, |
int | texno | ||
) |
PB2Export void SetSubMtlNo | ( | ParamID | id, |
int | mtlno | ||
) |
PB2Export int GetSubTexNo | ( | ParamID | id | ) |
PB2Export int GetSubMtlNo | ( | ParamID | id | ) |
PB2Export void SetInitFile | ( | ParamID | id, |
const MCHAR * | s | ||
) |
PB2Export const MCHAR* GetInitFile | ( | ParamID | id | ) |
PB2Export void AddInterface | ( | BaseInterface * | iface | ) |
Adds an interface to the descriptor's BaseInterfaceServer interfaces list.
The interface can later be obtained from the list using GetInterface()
[in] | iface | The interface to add |
PB2Export void RemoveInterface | ( | BaseInterface * | iface | ) |
Removes an interface from the descriptor's BaseInterfaceServer interfaces list.
[in] | iface | The interface to remove |
PB2Export void SetFileTypes | ( | ParamID | id, |
const MCHAR * | fileType | ||
) |
Allows a custom filter list to be supplied to the File dialog routines.
id | The parameter that defines a file dialog |
fileType | A string containing a correctly formated filter list. This buffer is maintained by the calling code |
const MCHAR* int_name |
USHORT count |
USHORT flags |
MSPluginClass* pc |
Rollout* rollout |