XSI Namespace Reference

All API classes defined in the C++ API are assigned to the XSI namespace. Members of the XSI namespace can be identified explicitly with the symbol XSI for code clarity. To simplify the code however, namespace members can be referenced without the namespace symbol by using the C++ using directive.

Function Documentation

CRef XSI::ConvertObject ( void * in_pAuto )

Converts an XSI Automation (XSI Object Model) object to a CRef object.

Note:: Normally XSI will automatically perform this conversion. For example when calling a custom Command implemented in C++ from scripting, any arguments which are objects will automatically be converted to the corresponding C++ API CRef-based object.

Parameters:

in_pAuto

IDispatch pointer to an XSI Automation object model interface (see CValue::DataType)

Returns:: The new CRef object

void* XSI::ConvertObject ( const CRef & in_obj )

Converts a CRef object to an XSI Automation (XSI Object Model) object. The returned pointer can be used to communicate with the object model.

The returned object pointer has been reference counted, and the caller is responsible for calling IDispatch::Release().

bool XSI::operator==	(	CStatus::Code	lhs,
		const CStatus &	rhs
	)

The equality operator that takes a Code on the left side and a CStatus object on the right side.

bool XSI::operator!=	(	CStatus::Code	lhs,
		const CStatus &	rhs
	)

The inequality operator that takes a Code on the left side and a CStatus object on the right side.

CString XSI::operator+	(	const wchar_t *	in_pwstr,
		const CString &	in_refStr
	)

CString XSI::operator+	(	const wchar_t	in_wchar,
		const CString &	in_refStr
	)

CString XSI::operator+	(	const char *	in_pstr,
		const CString &	in_refStr
	)

CString XSI::operator+	(	const char	in_char,
		const CString &	in_refStr
	)

bool XSI::operator==	(	const double	lhs,
		const CTime &	rhs
	)

Equality operator (takes a CTime::Format on the left side and a CTime object on the right side).

bool XSI::operator!=	(	const double	lhs,
		const CTime &	rhs
	)

Inequality operator (takes a CTime::Format on the left side and a CTime object on the right side).

XSI Namespace Reference

Classes

Namespaces

Enumerations

Functions

Variables

Detailed Description

Function Documentation


Classes
class	ActionDelta
	The ActionDelta object tracks changes made on a parameter that is part of a reference model. Every ActionDelta contains one or more ActionDeltaItem objects, each of which represents a single change, or modification, to a referenced parameter. Each ActionDelta object has a specific type (see siModificationDeltaType) and each ActionDeltaItem it contains is of the same type. More...
class	ActionDeltaItem
	The ActionDeltaItem object tracks changes made on a parameter that is part of a reference model. Each ActionDeltaItem represents a single change, or modification, to a referenced parameter. So each time there a change to a static value, an FCurve, a Constraint, an Expression or a GroupRelation, a new ActionDeltaItem is generated. More...
class	ActionSource
	The ActionSource class is a specialization of the Source class, representing sources for action and shape animation clips. More...
class	AnimationSourceItem
	An ActionSource contains a collection of animation source items, which you can get at using ActionSource::GetItems. The AnimationSourceItem class provides access to the animation DataSource (for example, an FCurve) and a target entity such as the Parameter or Cluster which the animation source drives. More...
class	AnimationSource
	The AnimationSource object represents a special kind of DataSource, for example, ActionSource, Constraint, FCurve, Expression, or StaticSource. More...
class	Application
	The Application object represents the running instance of the Softimage application and it is the top most entity of the C++ API object hierarchy. Application contains properties that return other Softimage objects such as the active scene root. More...
class	Argument
	The Argument object represents an argument (or parameter) of a Softimage Command. For example, the DeleteObj command takes 1 argument (`InputObj`). More...
class	ArgumentArray
class	ArgumentHandler
	An argument handler is an object that helps determine the value that is passed to a Command. More...
class	ArrayParameter
	An ArrayParameter is a specialization of a Parameter. More...
class	CBase
	CBase is the base class of all API classes and provides access to Softimage objects through generic CRef objects. The class defines a runtime type information sytem (RTTI) and CRef attachment support for API classes. More...
class	CBitArray
	This class encapsulates an array of binary values represented as booleans, where true indicates a bit set to ON and false indicates a bit set to OFF. More...
class	CBoolArray
	The CBoolArray is an uni-dimensional array of bool values. More...
class	Camera
	The Camera object represents a Softimage camera in a scene. More...
class	CameraRig
	The CameraRig object is a specialized Null object that represents a hierarchy composed of a Camera and its X3DObject interest object. More...
class	ChainBone
	The ChainBone object is part of a skeleton chain. More...
class	ChainEffector
	The ChainEffector object is part of a skeleton chain. More...
class	ChainElement
	The ChainElement object represents a component of a skeleton chain. More...
class	ChainRoot
	The ChainRoot object represents the root of a skeleton chain. More...
class	Clip

	lhs	status code
	rhs	status object

	lhs	status code
	rhs	status object

	lhs	time format
	rhs	time object