pymel.core.modeling.filterExpand

static modeling.filterExpand(*args, **kwargs)

Based on selected components (or components specified on the command line), the command filters and/or expands the list given the options. Returns a string array containing all matching selection items. Selection masks are as follows: Object TypeMaskHandle 0 Nurbs Curves 9 Nurbs Surfaces 10 Nurbs Curves On Surface 11 Polygon 12 Locator XYZ 22 Orientation Locator 23 Locator UV 24 Control Vertices (CVs) 28 Edit Points 30 Polygon Vertices 31 Polygon Edges 32 Polygon Face 34 Polygon UVs 35 Subdivision Mesh Points 36 Subdivision Mesh Edges 37 Subdivision Mesh Faces 38 Curve Parameter Points 39 Curve Knot 40 Surface Parameter Points 41 Surface Knot 42 Surface Range 43 Trim Surface Edge 44 Surface Isoparms 45 Lattice Points 46 Particles 47 Scale Pivots 49 Rotate Pivots 50 Select Handles 51 Subdivision Surface 68 Polygon Vertex Face 70 NURBS Surface Face 72 Subdivision Mesh UVs 73

Flags:

Long name (short name)		Argument Types	Properties
expand (ex)		bool
	Each item is a single entity if this is true. Default is true.
fullPath (fp)		bool
	If this is true and the selection item is a DAG object, return its full selection path, instead of the name of the object only when this value is false. Default is false. Flag can have multiple arguments, passed either as a tuple or a list.
selectionMask (sm)		int
	Specify the selection mask

Derived from mel command maya.cmds.filterExpand

Example:

import pymel.core as pm

# Returns any selected isoparms (mask 45) as individual items
# (because of "ex=True").
pm.filterExpand( ex=True, sm=45 )

# Returns any selected CVs (mask 28) as compact items.  For example,
#   if curve.cv[0:3] is selected, then "curve.cv[0:3]" is returned.
#   If "ex=True", then four items are returned, one for each CV.
pm.filterExpand( ex=False, sm=28 )

# Returns any selected CVs (mask 28) and edit points (mask 30).
pm.filterExpand( sm=(28,30) )

# Returns any selected nurbs curves.
pm.filterExpand( sm=9 )

# Returns any selected nurbs curves-on-surface.
pm.filterExpand( sm=11 )

# return the poly faces (mask 34) from the specified arguments
pm.filterExpand(["pCube1.f[1]","pCube1.f[4]","pCube1.vtx[0:3]"], sm=34)