Public Member Functions
GraphicSequencerContext Class Reference

## Detailed Description

This class represents the plug-in context for the Graphic Sequencer (CGraphicSequencer).

See also:
  Context, CGraphicSequencer

Since:
  4.0

`#include <xsi_graphicsequencercontext.h>`

Inheritance diagram for GraphicSequencerContext:
[legend]

List of all members.

## Public Member Functions
| GraphicSequencerContext ()
| ~GraphicSequencerContext ()
| GraphicSequencerContext (const CRef &in_ref)
| GraphicSequencerContext (const GraphicSequencerContext &in_obj)
bool | IsA (siClassID in_ClassID) const
siClassID | GetClassID () const
GraphicSequencerContext & | operator= (const GraphicSequencerContext &in_obj)
GraphicSequencerContext & | operator= (const CRef &in_ref)
CValue | GetUserData ()
CStatus | PutUserData (const CValue &in_val)
CGraphicSequencer | GetGraphicSequencer ()
CStatus | PutAttribute (const CString &in_AttributeName, const CValue &in_val)
CValue | GetAttribute (const CString &in_AttributeName)

## Constructor & Destructor Documentation

GraphicSequencerContext | ( |  | ) |

Default constructor.

~GraphicSequencerContext | ( |  | ) |

Default destructor.

GraphicSequencerContext | ( | const CRef & | in_ref | ) |

Constructor.

Parameters:

  in_ref | constant reference object.

GraphicSequencerContext | ( | const GraphicSequencerContext & | in_obj | ) |

Copy constructor.

Parameters:

  in_obj | constant 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.

Parameters:

  in_ClassID | class type.

Returns:
  true if the class is compatible, false otherwise.

Reimplemented from CBase.

siClassID GetClassID | ( |  | ) | const `[virtual]`

Returns the type of the API class.

Returns:
  The class type.

Implements CBase.

GraphicSequencerContext& operator= | ( | const GraphicSequencerContext & | in_obj | ) |

Creates an object from another object.

Parameters:

  in_obj | constant class object.

Returns:
  The new Context object.

GraphicSequencerContext& 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.

Parameters:

  in_ref | constant class object.

Returns:
  The new Context object.

CValue GetUserData | ( |  | ) |

Returns the user data stored in the context.

Warning:
  This function is not implemented.

Returns:
  The raw user data.

CStatus PutUserData | ( | const CValue & | in_val | ) |

Allows you to store a CValue inside the context object. This is called User Data because XSI does not care about the content or meaning of the data. This information is not persisted. A common use for this feature is to store a pointer to a newly allocated C++ object during an `Init` callback,and then to use Context::GetUserData to retrieve the pointer when other callbacks are made.

Warning:
  This function is not implemented.

Note:
  In the case of storing a pointer in the `Init` callback, the pointer should be destroyed in the `Term` callback.

Parameters:

  in_val | User data to be set for the operator instance.

Returns:
  CStatus::OK success
  CStatus::Fail failure.

CGraphicSequencer GetGraphicSequencer | ( |  | ) |

Returns the graphic sequencer object (CGraphicSequencer).

Returns:
  The CGraphicSequencer object.

CStatus PutAttribute | ( | const CString & | in_AttributeName,
|  | const CValue & | in_val
| ) |  |

Sets a single attribute value on the context. This is a way to pass additional information or capability to Softimage. Supported attributes are documented along with the cb_graphicsequencer Graphic Sequencer callbacks of each PluginItem. If the attribute does not exist it is added; otherwise the existing value is replaced by the new value.

Parameters:

  in_AttributeName | The name of the attribute to set.
  in_val | The attribute value to set.

Returns:
  CStatus::OK
  CStatus::Fail

Since:
  9.0 (2011)

CValue GetAttribute | ( | const CString & | in_AttributeName | ) |

Returns an attribute on the context. Attributes are used to provide additional context information or capability. Supported attributes, if any, are documented along with the cb_graphicsequencer Graphic Sequencer callbacks of each PluginItem.

Parameters:

  in_AttributeName | The name of the attribute to get.

Returns:
  The attribute value.

Since:
  9.0 (2011)

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

- xsi_graphicsequencercontext.h