class MFnSubdNames

Jump to documentation

Manipulate Subdivision Surface vertex, edge and face ids. (OpenMaya) (OpenMaya.py)

public members:

MFnSubdNames ()
~MFnSubdNames ()
static int base ( MUint64 id )
static int first ( MUint64 id )
static int level ( MUint64 id )
static int path ( MUint64 id )
static int corner ( MUint64 id )
static MStatus fromMUint64 ( MUint64 id, int& base , int& first , int& level , int& path , int& corner )
static MStatus toMUint64 ( MUint64& id, int base , int first , int level , int path , int corner )
static MUint64 baseFaceId ( MUint64 id )
static long baseFaceIndex ( MUint64 id )
OBSOLETE
static unsigned int baseFaceIndexFromId ( MUint64 id )
static MUint64 levelOneFaceId ( MUint64 id )
static long levelOneFaceAsLong ( MUint64 id )
OBSOLETE
static unsigned int levelOneFaceIndexFromId ( MUint64 id )
static MUint64 levelOneFaceIdFromLong ( long one )
OBSOLETE
static MUint64 levelOneFaceIdFromIndex ( unsigned int index )
static MUint64 baseFaceIdFromLong ( long base )
OBSOLETE
static MUint64 baseFaceIdFromIndex ( unsigned int index )
static MUint64 parentFaceId ( MUint64 id )
static MStatus nonBaseFaceVertices ( MUint64 id, MUint64& vertex1, MUint64& vertex2, MUint64& vertex3, MUint64& vertex4 )
static MStatus nonBaseFaceEdges ( MUint64 id, MUint64& edge1, MUint64& edge2, MUint64& edge3, MUint64& edge4)
static MStatus fromSelectionIndices ( MUint64& id, unsigned int firstIndex, unsigned int secondIndex )
static MStatus toSelectionIndices ( MUint64 id, unsigned int& firstIndex, unsigned int& secondIndex )

Documentation

Description

This function set provides some simple utilities for the interpretation and manipulation of the subdivision surface vertex, edge and face ids.

Functions

MFnSubdNames:: MFnSubdNames ()

Description

Class constructor.

MFnSubdNames:: ~MFnSubdNames ()

Description

Class destructor.

int MFnSubdNames:: base ( MUint64 id )

Description

Given a 64-bit name, return the base mesh face.

Arguments

  • id The 64-bit name of the component

int MFnSubdNames:: first ( MUint64 id )

Description

Given a 64-bit name, return the index of the first child of the base face.

Arguments

  • id The 64-bit name of the component

int MFnSubdNames:: level ( MUint64 id )

Description

Given a 64-bit name, return the level of the component

Arguments

  • id The 64-bit name of the component

int MFnSubdNames:: path ( MUint64 id )

Description

Given a 64-bit name, return from level 1 face down to the face in question. Two bits per level for the four possible choices.

Arguments

  • id The 64-bit name of the component

int MFnSubdNames:: corner ( MUint64 id )

Description

One of the 4 possible choices of the vertex or an edge once we're at the particular face.

Arguments

  • id The 64-bit name of the component

MStatus MFnSubdNames:: fromMUint64 ( MUint64 id, int& base , int& first , int& level , int& path , int& corner )

Description

Given a 64-bit name, compute the base face, first level face index, level, path to the face and the corner choice at the finest face.

Arguments

  • id The 64-bit name of the component
  • base Base face index
  • first First level face choice
  • level Level
  • path Path to the finest level
  • corner Corner choice at the finest level

MStatus MFnSubdNames:: toMUint64 ( MUint64& id, int base , int first , int level , int path , int corner )

Description

Compute the 64-bit name given the base face index, first level face index, level, path to the finest face and the corner choice. The corner is zero (ignore) if the component is to be the face.

Arguments

  • id The 64-bit name of the component
  • base Base face index
  • first First level face choice
  • level Level
  • path Path to the finest level
  • corner Corner choice at the finest level

MUint64 MFnSubdNames:: baseFaceId ( MUint64 id )

Description

Given a 64-bit name, return the 64-bit name of the base face that is the parent of the given component.

Arguments

  • id The 64-bit name of the component

long MFnSubdNames:: baseFaceIndex ( MUint64 id )

Description

This method is OBSOLETE. Use baseFaceIndexFromId instead.

Arguments

  • id The 64-bit name of the component

unsigned int MFnSubdNames:: baseFaceIndexFromId ( MUint64 id )

Description

Same as ::base().

Arguments

  • id The 64-bit name of the component

MUint64 MFnSubdNames:: levelOneFaceId ( MUint64 id )

Description

Given a 64-bit name, return the level one face that is the parent for the given component.

Arguments

  • id The 64-bit name of the component

long MFnSubdNames:: levelOneFaceAsLong ( MUint64 id )

Description

This method is OBSOLETE. Use levelOneFaceIdFromIndex instead.

Arguments

  • id The 64-bit name of the component

unsigned int MFnSubdNames:: levelOneFaceIndexFromId ( MUint64 id )

Description

Given a 64-bit name, return the level one mesh face as an integer, instead of 64-bit name.

Arguments

  • id The 64-bit name of the component

MUint64 MFnSubdNames:: levelOneFaceIdFromLong ( long one )

Description

This method is OBSOLETE. Use levelOneFaceIdFromIndex instead.

Arguments

  • id The 64-bit name of the component

MUint64 MFnSubdNames:: levelOneFaceIdFromIndex ( unsigned int index )

Description

Given a level 1 face name as integer, return it as a 64-bit name.

Arguments

  • id The 64-bit name of the component

MUint64 MFnSubdNames:: baseFaceIdFromLong ( long base )

Description

This method is OBSOLETE. Use baseFaceIdFromIndex instead.

Arguments

  • base The bae face name as integer 0, ... N-1

MUint64 MFnSubdNames:: baseFaceIdFromIndex ( unsigned int index )

Description

Given the index of the base face (0, 1, ... N-1), return its 64-bit name.

Arguments

  • base The bae face name as integer 0, ... N-1

MUint64 MFnSubdNames:: parentFaceId ( MUint64 id )

Description

Given a 64-bit name of the face, return its parent face id. Note that if the given face id is from a base face (ie. it is a face at level 0), the returned face will be exactly the same.

Arguments

  • id The 64-bit name of the component

MStatus MFnSubdNames:: nonBaseFaceVertices ( MUint64 id, MUint64& vertex1, MUint64& vertex2, MUint64& vertex3, MUint64& vertex4 )

Description

Return the four vertices on the given face. Note that the face should not be a base mesh face (the level > 0).

Arguments

  • id The id of the face
  • vertex1 The first vertex
  • vertex2 The second vertex
  • vertex3 The third vertex
  • vertex4 The fourth vertex

Status Codes

  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.

MStatus MFnSubdNames:: nonBaseFaceEdges ( MUint64 id, MUint64& edge1, MUint64& edge2, MUint64& edge3, MUint64& edge4 )

Description

Return the four edges on the given face. Note that the face should not be a base mesh face (the level > 0).

Arguments

  • id The id of the face
  • edge1 The first edge
  • edge2 The second edge
  • edge3 The third edge
  • edge4 The fourth edge

Status Codes

  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.

MStatus MFnSubdNames:: fromSelectionIndices ( MUint64& id, unsigned int firstIndex, unsigned int secondIndex )

Description

Given the two integers that would show as selection indices for the subd component, return the 64-bit name for that component.

Arguments

  • id The 64-bit name of the component
  • firstIndex The first selection index
  • secondIndex The second selection index

MStatus MFnSubdNames:: toSelectionIndices ( MUint64 id, unsigned int& firstIndex, unsigned int& secondIndex )

Description

Given a 64-bit name, return the two integers that will show up as selection indices for that subd component.

Arguments

  • id The 64-bit name of the component
  • firstIndex The first selection index
  • secondIndex The second selection index

This class has no child classes.

Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright