UpdateContext Class
Reference
#include <xsi_updatecontext.h>
This object represents the operator update context. It gives access to the operator and the evaluation time. The UpdateContext is only valid within the context of the Update() function for operators that are based on a Preset and SPDL. Self-Installed CustomOperators use the OperatorContext object instead.
Public Member Functions |
|
| UpdateContext () | |
| ~UpdateContext () | |
| UpdateContext (const CRef &in_ref) | |
| UpdateContext (const UpdateContext &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| UpdateContext & | operator= (const UpdateContext &in_obj) |
| UpdateContext & | operator= (const CRef &in_ref) |
| Operator | GetOperator () |
| double | GetCurrentFrame () |
| CValue | GetUserData () |
| CStatus | PutUserData (const CValue &in_val) |
| UpdateContext | ( | ) |
Default constructor.
| ~UpdateContext | ( | ) |
Default destructor.
| UpdateContext | ( | const CRef & | in_ref | ) |
Constructor.
| in_ref | constant reference object. |
| UpdateContext | ( | const UpdateContext & | in_obj | ) |
Copy constructor.
| in_obj | constant class object. |
| bool IsA | ( | siClassID | in_ClassID | ) | const [virtual] |
Returns true if a given class type is compatible with this API class.
| in_ClassID | class type. |
Reimplemented from SIObject.
| siClassID GetClassID | ( | ) | const [virtual] |
| UpdateContext& operator= | ( | const UpdateContext & | in_obj | ) |
Creates an object from another object. The newly created object is set to empty if the input object is not compatible.
| in_obj | constant class object. |
| UpdateContext& operator= | ( | const CRef & | in_ref | ) |
Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.
| in_ref | constant class object. |
Reimplemented from SIObject.
| Operator GetOperator | ( | ) |
| double GetCurrentFrame | ( | ) |
| CValue GetUserData | ( | ) |
Returns the user data stored in the UpdateContext.
Sets user data which is passed to the compiled scripted operator from evaluation to evaluation.
| in_val | user data to be set for the operator instance. |