#include <iparamb.h>
Class Description
- See also:
- Class
ReferenceTarget, Class IParamArray, Parameter Maps,
Class ParamBlockDescID, Class
Control.
- Description:
- This class provides methods to work with parameter blocks. For
more details on parameter blocks see Parameter
Blocks.
Public Member Functions
|
virtual
SClass_ID |
GetAnimParamControlType
(int anim)=0 |
virtual
ParamType |
GetParameterType
(int i)=0 |
virtual
BOOL |
SetValue
(int i, TimeValue
t, float v)=0 |
virtual
BOOL |
SetValue
(int i, TimeValue
t, int v)=0 |
virtual
BOOL |
SetValue
(int i, TimeValue
t, Point3 &v)=0 |
virtual
BOOL |
SetValue
(int i, TimeValue
t, Color &v)=0 |
virtual
BOOL |
GetValue
(int i, TimeValue
t, float &v, Interval &ivalid)=0 |
virtual
BOOL |
GetValue
(int i, TimeValue
t, int &v, Interval &ivalid)=0 |
virtual
BOOL |
GetValue
(int i, TimeValue
t, Point3 &v,
Interval
&ivalid)=0 |
virtual
BOOL |
GetValue
(int i, TimeValue
t, Color &v,
Interval
&ivalid)=0 |
virtual
Color |
GetColor
(int i, TimeValue
t=0)=0 |
virtual
Point3 |
GetPoint3
(int i, TimeValue
t=0)=0 |
virtual
int |
GetInt
(int i, TimeValue
t=0)=0 |
virtual
float |
GetFloat
(int i, TimeValue
t=0)=0 |
virtual
DWORD |
GetVersion
()=0 |
virtual
int |
NumParams
()=0 |
virtual
void |
RemoveController
(int i)=0 |
virtual
Control * |
GetController
(int i)=0 |
virtual
void |
SetController
(int i, Control *c,
BOOL preserveFrame0Value=TRUE)=0 |
virtual
void |
SwapControllers
(int j, int k)=0 |
virtual
int |
GetRefNum
(int paramNum)=0 |
virtual
int |
GetAnimNum
(int paramNum)=0 |
virtual
int |
AnimNumToParamNum
(int animNum)=0 |
IParamBlock * |
GetParamBlock
() |
virtual
void |
RescaleParam
(int paramNum, float f)=0 |
virtual
int |
LastNotifyParamNum
()=0 |
Member Function Documentation
virtual SClass_ID
GetAnimParamControlType |
( |
int |
anim |
) |
[pure virtual] |
- Parameters:
- int anim
Specifies the parameter whose controller super class ID is
returned.
virtual ParamType
GetParameterType |
( |
int |
i |
) |
[pure virtual] |
virtual BOOL SetValue |
( |
int |
i, |
|
|
TimeValue |
t, |
|
|
float |
v |
|
) |
|
[pure virtual] |
- Parameters:
- int i
This is the index into the ParamBlockDesc array of the
parameter to set.
TimeValue t
The time at which to set the value.
float v
The value to store.
- Returns:
- If the value was set TRUE is returned; otherwise FALSE is
returned.
Reimplemented from IParamArray.
virtual BOOL SetValue |
( |
int |
i, |
|
|
TimeValue |
t, |
|
|
int |
v |
|
) |
|
[pure virtual] |
virtual BOOL SetValue |
( |
int |
i, |
|
|
TimeValue |
t, |
|
|
Color & |
v |
|
) |
|
[pure virtual] |
virtual BOOL GetValue |
( |
int |
i, |
|
|
TimeValue |
t, |
|
|
float & |
v, |
|
|
Interval & |
ivalid |
|
) |
|
[pure virtual] |
- Parameters:
- int i
Index into the ParamBlockDesc array of the
parameter to retrieve.
TimeValue t
The time at which to retrieving a value.
float v
The value to store for the parameter at the time.
Interval
&ivalid
The interval to update.
- Returns:
- The return value is TRUE if a value was retrieved. Otherwise it
is FALSE.
- See also:
- Parameter
Blocksin the Advanced Topics section, Intervals.
Reimplemented from IParamArray.
virtual BOOL GetValue |
( |
int |
i, |
|
|
TimeValue |
t, |
|
|
int & |
v, |
|
|
Interval & |
ivalid |
|
) |
|
[pure virtual] |
virtual int GetInt |
( |
int |
i, |
|
|
TimeValue |
t = 0 |
|
) |
|
[pure virtual] |
virtual float GetFloat |
( |
int |
i, |
|
|
TimeValue |
t = 0 |
|
) |
|
[pure virtual] |
virtual DWORD GetVersion |
( |
|
) |
[pure virtual] |
virtual int NumParams |
( |
|
) |
[pure virtual] |
virtual void RemoveController |
( |
int |
i |
) |
[pure virtual] |
- Parameters:
- int i
The parameter index of the controller to remove.
virtual Control* GetController |
( |
int |
i |
) |
[pure virtual] |
- Parameters:
- int i
The parameter index of the controller to return.
virtual void SetController |
( |
int |
i, |
|
|
Control * |
c, |
|
|
BOOL |
preserveFrame0Value =
TRUE |
|
) |
|
[pure virtual] |
- Parameters:
- int i
The index of the parameter to set.
Control *c
The controller to set.
BOOL preserveFrame0Value=TRUE
If TRUE the controllers value at frame 0 is preserved.
virtual void SwapControllers |
( |
int |
j, |
|
|
int |
k |
|
) |
|
[pure virtual] |
- Parameters:
- int j, int k
The parameter indices whose controllers should be swapped.
virtual int GetRefNum |
( |
int |
paramNum |
) |
[pure virtual] |
- Parameters:
- int paramNum
The parameter index.
virtual int GetAnimNum |
( |
int |
paramNum |
) |
[pure virtual] |
- Parameters:
- int paramNum
The parameter index.
virtual int AnimNumToParamNum |
( |
int |
animNum |
) |
[pure virtual] |
- Parameters:
- int animNum
The anim number.
- Returns:
- Returns a pointer to the parameter block if one is used; NULL
otherwise.
Reimplemented from IParamArray.
virtual void RescaleParam |
( |
int |
paramNum, |
|
|
float |
f |
|
) |
|
[pure virtual] |
- Parameters:
- int paramNum
The index into the parmeter block of the parameter to
rescale.
float f
The value to scale by.
virtual int LastNotifyParamNum |
( |
|
) |
[pure virtual] |
- Sample Code:
-
case REFMSG_CHANGE:
if (hTarget == pblock)
{
int np = pblock->LastNotifyParamNum();
}
break;