MManipData Class Reference

#include <MManipData.h>

Class Description

Manipulator Data.

This class encapulates manipulator data which is returned from the manipulator conversion functions. MManipData is used to represent data that is either simple or complex. Simple data is used to represent bool, short, int, unsigned int, float, and double types. Complex data is used to represent MObjects created by MFnData, or classes derived from MFnData.

Examples:

Public Member Functions
	MManipData ()
	The default class constructor.
	~MManipData ()
	The destructor.
	MManipData (const MManipData &)
	The copy constructor. More...
	MManipData (bool)
	Constructor for bool types. More...
	MManipData (short)
	Constructor for short types. More...
	MManipData (int)
	Constructor for int types. More...
	MManipData (unsigned int)
	Constructor for unsigned int types. More...
	MManipData (float)
	Constructor for float types. More...
	MManipData (double)
	Constructor for double types. More...
	MManipData (const MObject &)
	Constructor for MObject types created by MFnData, or classes derived from MFnData. More...
MManipData &	operator= (const MManipData &)
	The assignment operator. More...
MManipData &	operator= (bool)
	The assignment operator for bool types. More...
MManipData &	operator= (short)
	The assignment operator for short types. More...
MManipData &	operator= (int)
	The assignment operator for int types. More...
MManipData &	operator= (unsigned int)
	The assignment operator for unsigned int types. More...
MManipData &	operator= (float)
	The assignment operator for float types. More...
MManipData &	operator= (double)
	The assignment operator for double types. More...
MManipData &	operator= (const MObject &)
	The assignment operator for MObject types created by MFnData, or classes derived from MFnData. More...
bool	isSimple () const
	Returns whether or not the manipulator data is simple or complex. More...
bool	asBool () const
	Returns the manipulator data as a bool. More...
short	asShort () const
	Returns the manipulator data as a short. More...
int	asLong () const
	Returns the manipulator data as a int. More...
unsigned int	asUnsigned () const
	Returns the manipulator data as an unsigned int. More...
float	asFloat () const
	Returns the manipulator data as a float. More...
double	asDouble () const
	Returns the manipulator data as a double. More...
MObject	asMObject () const
	Returns the manipulator data as an MObject. More...

Static Public Member Functions
static const char *	className ()
	Returns the name of this class. More...

Constructor & Destructor Documentation

MManipData

(

const MManipData &

other

)

The copy constructor.

Parameters

[in]

other

Object to copy from.

MManipData

(

bool

data

)

Constructor for bool types.

Parameters

[in]

data

Initial value.

MManipData

(

short

data

)

Constructor for short types.

Parameters

[in]

data

Initial value.

MManipData

(

int

data

)

Constructor for int types.

Parameters

[in]

data

Initial value.

MManipData

(

unsigned int

data

)

Constructor for unsigned int types.

Parameters

[in]

data

Initial value.

MManipData

(

float

data

)

Constructor for float types.

Parameters

[in]

data

Initial value.

MManipData

(

double

data

)

Constructor for double types.

Parameters

[in]

data

Initial value.

MManipData

(

const MObject &

data

)

Constructor for MObject types created by MFnData, or classes derived from MFnData.

Parameters

[in]

data

Initial value.

Member Function Documentation

MManipData & operator=

(

const MManipData &

other

)

The assignment operator.

Parameters

[in]

other

Object to copy from.

MManipData & operator=

(

bool

data

)

The assignment operator for bool types.

Parameters

[in]

data

value to copy from.

MManipData & operator=

(

short

data

)

The assignment operator for short types.

Parameters

[in]

data

value to copy from.

MManipData & operator=

(

int

data

)

The assignment operator for int types.

Parameters

[in]

data

value to copy from.

MManipData & operator=

(

unsigned int

data

)

The assignment operator for unsigned int types.

Parameters

[in]

data

value to copy from.

MManipData & operator=

(

float

data

)

The assignment operator for float types.

Parameters

[in]

data

value to copy from.

MManipData & operator=

(

double

data

)

The assignment operator for double types.

Parameters

[in]

data

value to copy from.

MManipData & operator=

(

const MObject &

data

)

The assignment operator for MObject types created by MFnData, or classes derived from MFnData.

Parameters

[in]

data

value to copy from.

bool isSimple

(

)

const

Returns whether or not the manipulator data is simple or complex.

Simple data is used to represent bool, short, int, unsigned int, float, and double types. Complex data is used to represent MObjects created by MFnData, or classes derived from MFnData.

Returns

Whether or not the manipulator data is simple or complex

bool asBool

(

)

const

Returns the manipulator data as a bool.

Returns

The data as a bool

short asShort

(

)

const

Returns the manipulator data as a short.

Returns

The data as a short

int asLong

(

)

const

Returns the manipulator data as a int.

Returns

The data as a int

unsigned int asUnsigned

(

)

const

Returns the manipulator data as an unsigned int.

Returns

The data as an unsigned int

float asFloat

(

)

const

Returns the manipulator data as a float.

Returns

The data as a float

double asDouble

(

)

const

Returns the manipulator data as a double.

Returns

The data as a double

MObject asMObject

(

)

const

Returns the manipulator data as an MObject.

The MObjects returned from this method are created and used by MFnData or classes derived from MFnData.

Returns

The data as an MObject

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:

• MManipData.h
• MManipData.cpp