Public Member Functions
UpdateContext Class Reference

Detailed Description

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.

See also:
Operator, OperatorContext

#include <xsi_updatecontext.h>

Inheritance diagram for UpdateContext:
Inheritance graph

List of all members.

Public Member Functions

 UpdateContext ()
 ~UpdateContext ()
 UpdateContext (const CRef &in_ref)
 UpdateContext (const UpdateContext &in_obj)
bool IsA (siClassID in_ClassID) const
siClassID GetClassID () const
UpdateContextoperator= (const UpdateContext &in_obj)
UpdateContextoperator= (const CRef &in_ref)
Operator GetOperator ()
double GetCurrentFrame ()
CValue GetUserData ()
CStatus PutUserData (const CValue &in_val)

Constructor & Destructor Documentation

Default constructor.

Default destructor.

UpdateContext ( const CRef in_ref)


in_refconstant reference object.
UpdateContext ( const UpdateContext in_obj)

Copy constructor.

in_objconstant class object.

Member Function Documentation

bool IsA ( siClassID  in_ClassID) const [virtual]

Returns true if a given class type is compatible with this API class.

in_ClassIDclass type.
true if the class is compatible, false otherwise.

Reimplemented from SIObject.

siClassID GetClassID ( ) const [virtual]

Returns the type of the API class.

The class type.

Reimplemented from SIObject.

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_objconstant class object.
The new UpdateContext 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_refconstant class object.
The new UpdateContext object.

Reimplemented from SIObject.

Operator GetOperator ( )

Returns the Operator object for the update context.

The current Operator.
double GetCurrentFrame ( )

Returns the time in frames at which the Operator is being evaluated.

Time (frame) at which the Operator is being evaluated.
CValue GetUserData ( )

Returns the user data stored in the UpdateContext.

The user data.
CStatus PutUserData ( const CValue in_val)

Sets user data which is passed to the compiled scripted operator from evaluation to evaluation.

in_valuser data to be set for the operator instance.
CStatus::OK success
CStatus::Fail failure.

The documentation for this class was generated from the following file: