Go to: Synopsis. Return value. Flags. Python examples.
planarSrf( objects , [caching=boolean], [constructionHistory=boolean],
[degree=int], [keepOutside=boolean], [name=string], [nodeState=int], [object=boolean], [polygon=int], [range=boolean], [tolerance=linear])
Note: Strings representing object names and
arguments must be separated by commas. This is not depicted in the
synopsis.
planarSrf is undoable, queryable, and editable.
This command computes a planar trimmed surface given planar
boundary curves that form a closed region.
string[] |
Object name and node name |
In query mode, return type is based on queried flag.
caching, constructionHistory, degree, keepOutside, name,
nodeState, object, polygon,
range, tolerance
Long name (short name) |
Argument types |
Properties |
degree(d) |
int |
|
|
The degree of the resulting surface: 1 - linear, 3 -
cubic
Default: 3 |
|
keepOutside(ko) |
boolean |
|
|
If true, keep the regions outside the given curves.
Default: false |
|
tolerance(tol) |
linear |
|
|
The distance tolerance for the cvs of the curves to be in the
same plane.
Default: 0.01 |
|
Advanced flags |
caching(cch) |
boolean |
|
|
Modifies the node caching mode. See the node documentation for
more information.
Note: For advanced users only. |
|
nodeState(nds) |
int |
|
|
Modifies the node state. See the node documentation for more
information.
Note: For advanced users only. |
|
Common flags |
name(n) |
string |
|
|
Name the resulting object |
|
constructionHistory(ch) |
boolean |
|
|
Turn the construction history on or off |
|
object(o) |
boolean |
|
|
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 surface
- 1: polygon (use nurbsToPolygonsPref to set the parameters for
the conversion)
- 2: subdivision surface (use nurbsToSubdivPref to set the
parameters for the conversion)
- 3: Bezier surface
- 4: subdivision surface solid (use nurbsToSubdivPref to set the
parameters for the conversion)
|
|
range(rn) |
boolean |
|
|
Force a curve range on complete input curve |
|
Flag can appear in Create mode of
command |
Flag can appear in Edit mode of command |
Flag can appear in Query mode of command |
Flag can have multiple arguments, passed
either as a tuple or a list. |
import maya.cmds as cmds
# create linear planar trimmed surface given boundary curve(s)
cmds.planarSrf( d=1 )
# use boundary curve(s) to create a hole by
# keeping the outside trimmed regions
cmds.planarSrf( ko=True)