pymel.core.modeling.planarSrf

planarSrf(*args, **kwargs)

This command computes a planar trimmed surface given planar boundary curves that form a closed region.

Flags:

Long name (short name)		Argument Types	Properties
caching (cch)		bool
	Modifies the node caching mode. See the node documentation for more information.Note:For advanced users only.
constructionHistory (ch)		bool
	Turn the construction history on or off
degree (d)		int
	The degree of the resulting surface: 1 - linear, 3 - cubicDefault:3
keepOutside (ko)		bool
	If true, keep the regions outside the given curves.Default:false
name (n)		unicode
	Sets the name of the newly-created node. If it contains namespace path, the new node will be created under the specified namespace; if the namespace does not exist, it will be created.
nodeState (nds)		int
	Modifies the node state. See the node documentation for more information.Note:For advanced users only.Common flags
object (o)		bool
	Create the result, or just the dependency node
polygon (po)		int
	The value of this argument controls the type of the object created by this operation 0: nurbs surface1: polygon (use nurbsToPolygonsPref to set the parameters for the conversion)2: subdivision surface (use nurbsToSubdivPref to set the parameters for the conversion)3: Bezier surface4: subdivision surface solid (use nurbsToSubdivPref to set the parameters for the conversion)
range (rn)		bool
	Force a curve range on complete input curveFlag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
tolerance (tol)		float
	The distance tolerance for the cvs of the curves to be in the same plane.Default:0.01Advanced flags

Derived from mel command maya.cmds.planarSrf

Example:

import pymel.core as pm

# create linear planar trimmed surface given boundary curve(s)
pm.planarSrf( d=1 )

# use boundary curve(s) to create a hole by
# keeping the outside trimmed regions
pm.planarSrf( ko=True)