MDGContext Class Reference
 
 
 
MDGContext Class Reference

This reference page is linked to from the following overview topics: Example custom transform, Appendix C: Frequently asked questions.


#include <MDGContext.h>


Class Description

List of all members.

Public Member Functions

  MDGContext ()
  Constructor.
  MDGContext (const MTime &when)
  Constructor.
  MDGContext (const MDGContext &in)
  Copy constructor.
  ~MDGContext ()
  Destructor.
bool  isNormal (MStatus *ReturnStatus=NULL) const
  Determines if this context is that of "normal" evaluation.
MStatus  getTime (MTime &) const
  Return the single time for which this context is valid.
MDGContext operator= (const MDGContext &other)
  Assignment operator.

Static Public Member Functions

static const char *  className ()
  Returns the name of this class.

Friends

class  MPlug
class  MDataBlock

Constructor & Destructor Documentation

Constructor.

Creates a context to define the way in which a dependency node is evaluated. In this case the new context will be for a normal evaluation.

MDGContext ( const MTime atTime )

Constructor.

Creates a context to define the way in which a dependency node is evaluated. In this case the new context will be for an evaluation at a specific time.

Parameters:
[in] atTime The time in which the evaluation will take place
MDGContext ( const MDGContext other )

Copy constructor.

Duplicates the given DG context.

Parameters:
[in] other DG context to be copied.

Member Function Documentation

bool isNormal ( MStatus ReturnStatus = NULL ) const

Determines if this context is that of "normal" evaluation.

Parameters:
[out] ReturnStatus Status code
Returns:
  • true this context is normal
  • false this context is not normal
Status Codes:
Examples:
rockingTransformCheck/rockingTransformCheck.cpp.
MStatus getTime ( MTime timeVal ) const

Return the single time for which this context is valid.

The context must be a timed context, i.e. not a normal one.

Parameters:
[out] timeVal Storage for the time
Returns:
Status Code
Status Codes:
MDGContext & operator= ( const MDGContext other )

Assignment operator.

Copies the RHS into this context.

Parameters:
[in] other DG context to be copied.
const char * className ( ) [static]

Returns the name of this class.

Returns:
Name of this class.

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