MAttributeSpec Class Reference
[OpenMaya - API module for common classes]

#include <MAttributeSpec.h>

List of all members.

---

Detailed Description

An attribute specification.

Class that encapsulates component/attribute information for generating selection items.

This class is used by MPxSurfaceShape::matchComponent for validating attributes specified as strings and converting that specification to a component object.

The attribute specification ".foo.bar[3].x" would be expressed like this (using a pseudo-structure description):

    MAttributeSpecArray[0..3] {
        MAttributeSpec[0] {
            name      = "foo"
            dimension = 0
        }
        MAttributeSpec[1] {
            name      = "bar"
            dimension = 1
            MAttributeIndex[0] = {
                type      = kInteger
                isRange   = false
                isBounded = true
                value     = 3
            }
        }
        MAttributeSpec[2] {
            name      = "x"
            dimension = 0
        }
    }

Examples:

apiMeshShape.cpp.

Public Member Functions
	MAttributeSpec ()
	MAttributeSpec (const char *name)
	MAttributeSpec (const MString &name)
	MAttributeSpec (const MAttributeSpec &other)
	~MAttributeSpec ()
const MString	name () const
int	dimensions () const
void	setName (const MString &name)
void	setDimensions (int value)
MAttributeSpec &	operator= (const MAttributeSpec &rhs)
const MAttributeIndex	operator[] (int index) const
bool	operator== (const MAttributeSpec &other) const
MAttributeIndex	operator[] (int index)
	NO SCRIPT SUPPORT.

---

Constructor & Destructor Documentation

MAttributeSpec::MAttributeSpec

(

)

Constructor.

MAttributeSpec::MAttributeSpec

(

const char *

name

)

Constructor.

Creates an attribute specification with the given attribute name.

Parameters:

[in]

name

the attribute name to set

MAttributeSpec::MAttributeSpec

(

const MString &

name

)

Constructor.

Creates an attribute specification with the given attribute name.

Parameters:

[in]

name

the attribute name to set

MAttributeSpec::MAttributeSpec

(

const MAttributeSpec &

other

)

Copy constructor.

Parameters:

[in]

other

the attribute specification to copy

MAttributeSpec::~MAttributeSpec

(

)

Destructor.

---

Member Function Documentation

const MString MAttributeSpec::name

(

)

const

Returns the attribute name part of the specification.

Returns:

The attribute name

Examples:

apiMeshShape.cpp.

int MAttributeSpec::dimensions

(

)

const

Returns the dimension of the attribute specification. For array attributes the dimension is > 0.

Returns:

The attributes dimension

Examples:

apiMeshShape.cpp.

void MAttributeSpec::setName

(

const MString &

name

)

Set the attribute name part of the specification.

Parameters:

[in]

name

the name to be set

void MAttributeSpec::setDimensions

(

int

value

)

Set the dimension of the attribute specification. Array attribute dimensions are > 0.

Parameters:

[in]

value

the dimension value to be set

MAttributeSpec & MAttributeSpec::operator=

(

const MAttributeSpec &

rhs

)

Assignment operator.

Parameters:

[in]

rhs

attribute specification to copy

Returns:

A reference to the copied MAttributeSpec object.

const MAttributeIndex MAttributeSpec::operator[]

(

int

index

)

const

Returns an attribute index object for the specified element.

Parameters:

[in]

index

attribute index to return

Returns:

The MAttributeIndex associated with the given index.

bool MAttributeSpec::operator==

(

const MAttributeSpec &

other

)

const

Comparison operator.

Parameters:

[in]

other

attribute specifier to be compared

Returns:

The boolean indicating whether the object are same or not.

MAttributeIndex MAttributeSpec::operator[]

(

int

index

)

NO SCRIPT SUPPORT.

Returns an attribute index object for the specified element.

Parameters:

[in]

index

attribute index to return

Returns:

The MAttributeIndex associated with the given index.