#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):
Constructor & Destructor Documentation
MAttributeSpec::MAttributeSpec |
( |
|
) |
|
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 |
Copy constructor.
- Parameters:
-
[in] |
other |
the attribute specification to copy |
MAttributeSpec::~MAttributeSpec |
( |
|
) |
|
Member Function Documentation
const MString MAttributeSpec::name |
( |
|
) |
const |
Returns the attribute name part of the specification.
- Returns:
- The attribute name
int MAttributeSpec::dimensions |
( |
|
) |
const |
Returns the dimension of the attribute specification. For array
attributes the dimension is > 0.
- Returns:
- The attributes dimension
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 |
Assignment operator.
- Parameters:
-
[in] |
rhs |
attribute specification to copy |
- Returns:
- A reference to the copied MAttributeSpec object.
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.
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.