pw:: SurfaceTrim

Database trim surface type

Derives From

pw::Object pw::Entity pw::DatabaseEntity

Summary
Database trim surface type
This action automatically creates new database trim surfaces using the given surfaces and its limits as the boundaries.
This action automatically creates new trim surfaces using the given intersection, projection and boundary curves as boundaries.
This action gets all trim surface boundaries that are supported by the given pw::Curve object.
This action gets the position in the defining space of the surface at the given parameter.
This action gets the position in model space of the surface at the given parameter.
This action gets the number of boundary curves of the trim surface.
This action gets a trim surface boundary.
This action gets a trim surface boundary list.
This action gets the pw::Curve object that serves as the trim surface boundary.
This action gets the pw::Curve objects that serve as the trim surface boundaries.
This action gets the groups of boundaries of the trim surface.
This action untrims the boundaries of a trim surface.
This action gets all the curves that are at least partially on the interior of the trim surface, but not used in the boundaries.
This action returns itself.
This action gets the surface being trimmed.
This action gets the quilt that contains this trim surface.
This action gets the model that contains this trim surface.
This action split the trim surface’s quilt and model so that this trim surface is in its own quilt and model.

Static Actions

createFromSurfaces

pw::SurfaceTrim createFromSurfaces surfaces

This action automatically creates new database trim surfaces using the given surfaces and its limits as the boundaries.

Parameters

surfacesThis parameter is a list of pw::Surface objects.

Returns

This action returns a list of new pw::SurfaceTrim objects.

createFromCurves

pw::SurfaceTrim createFromCurves curves

This action automatically creates new trim surfaces using the given intersection, projection and boundary curves as boundaries.  The surfaces that are trimmed are those on which the curves depend.

Parameters

curvesThis parameter is a list of pw::Curve objects and/or boundary curves.

Returns

This action returns a list of new pw::SurfaceTrim objects.

getBoundariesFromCurve

pw::SurfaceTrim getBoundariesFromCurve <curve>

This action gets all trim surface boundaries that are supported by the given pw::Curve object.

Parameters

curveThis parameter is a pw::Curve object

Returns

This action returns a list of boundaries.

Instance Actions

getPosition

$tsurf getPosition ?-parameter? value

This action gets the position in the defining space of the surface at the given parameter.

Parameters

-parameterThis indicates to get the position at a parameter.  The value is a uv parameter that is subject to the limits of the underlying surface.  This is the default option.
valueThis is the parameter value at which to get the position.

Returns

This action returns a point giving the position on the surface.

getXYZ

$tsurf getXYZ ?-parameter? value

This action gets the position in model space of the surface at the given parameter.

Parameters

-parameterThis indicates to get the position at a parameter.  The value is a uv parameter that is subject to the limits of the underlying surface.  This is the default option.
valueThis is the parametric value at which to get the position.

Returns

This action returns an XYZ vector.

getBoundaryCount

$tsurf getBoundaryCount

This action gets the number of boundary curves of the trim surface.

Parameters

none

Returns

This action returns the number of boundary curves of the trim surface.

getBoundary

$tsurf getBoundary index

This action gets a trim surface boundary.

Parameters

indexThis parameter is the index of the boundary to get.

Returns

This action returns a boundary.

getBoundaries

$tsurf getBoundaries

This action gets a trim surface boundary list.

Parameters

This action has no parameters.

Returns

This action returns a boundary list.

getBoundaryCurve

$tsurf getBoundaryCurve index

This action gets the pw::Curve object that serves as the trim surface boundary.

Parameters

indexThis parameter is the index of the boundary to get the curve of.

Returns

This action returns a pw::Curve object.

getBoundaryCurves

This action gets the pw::Curve objects that serve as the trim surface boundaries.

Parameters

This action has no parameters.

Returns

This action returns a pw::Curve object list.

getBoundaryGroups

$tsurf getBoundaryGroups ?-usage use? ?-loop type? ?-untrimable?

This action gets the groups of boundaries of the trim surface.  The types of groups can be limited by the optional parameters

Parameters

-usage useThis optional parameter limits the returned groups to only those that contain boundaries of a given usage with valid values < All | Lamina | Manifold >.
-loop typeThis optional parameter limits the returned groups to only those that contain boundaries in the given loop type with valid values < All | Outer | Inner >.
-untrimmableThis optional parameter limits the returned groups to only those that lie on the interior of the base surface, thus making the groups untrimmable by the untrimBoundaries action.

Returns

This action returns a list of boundary groups, with each boundary group represented as a list of boundary indexes.

untrimBoundaries

$tsurf untrimBoundaries indices

This action untrims the boundaries of a trim surface.

Parameters

indicesThis parameter is a list of boundary indices to untrim.

Returns

This action returns nothing.

Information

Untrimming a boundary will cause all boundaries in the boundary’s group to be untrimmed.  If the boundary is not in an untrimmable group, the action will error and no boundaries will be untrimmed.

getInteriorCurves

$tsurf getInteriorCurves

This action gets all the curves that are at least partially on the interior of the trim surface, but not used in the boundaries.

Parameters

This action has no parameters.

Returns

This action returns a list of pw::Curve objects.

getSurfaceTrims

$tsurf getSurfaceTrims

This action returns itself.  It exists primarily for completeness to match the same function for pw::Quilt and pw::Model objects.

Parameters

This action has no parameters.

Returns

This action returns itself.

getSurface

$tsurf getSurface

This action gets the surface being trimmed.

Parameters

none

Returns

This action returns a pw::Surface object.

getQuilt

$tsurf getQuilt

This action gets the quilt that contains this trim surface.

Parameters

none

Returns

This action returns a pw::Quilt object.

getModel

$tsurf getModel

This action gets the model that contains this trim surface.

Parameters

none

Returns

This action returns a pw::Model object.

isolate

$tsurf isolate

This action split the trim surface’s quilt and model so that this trim surface is in its own quilt and model.

Parameters

none

Returns

This action returns the new pw::Model object that contains the trim surface.

pw::SurfaceTrim createFromSurfaces surfaces
This action automatically creates new database trim surfaces using the given surfaces and its limits as the boundaries.
pw::SurfaceTrim createFromCurves curves
This action automatically creates new trim surfaces using the given intersection, projection and boundary curves as boundaries.
pw::SurfaceTrim getBoundariesFromCurve <curve>
This action gets all trim surface boundaries that are supported by the given pw::Curve object.
Database curve type
$tsurf getPosition ?-parameter? value
This action gets the position in the defining space of the surface at the given parameter.
$tsurf getXYZ ?-parameter? value
This action gets the position in model space of the surface at the given parameter.
$tsurf getBoundaryCount
This action gets the number of boundary curves of the trim surface.
$tsurf getBoundary index
This action gets a trim surface boundary.
A boundary is reference to either a database curve or the edge of a database surface.
$tsurf getBoundaries
This action gets a trim surface boundary list.
$tsurf getBoundaryCurve index
This action gets the pw::Curve object that serves as the trim surface boundary.
$tsurf getBoundaryGroups ?-usage use? ?-loop type? ?-untrimable?
This action gets the groups of boundaries of the trim surface.
$tsurf untrimBoundaries indices
This action untrims the boundaries of a trim surface.
$tsurf getInteriorCurves
This action gets all the curves that are at least partially on the interior of the trim surface, but not used in the boundaries.
$tsurf getSurfaceTrims
This action returns itself.
$tsurf getSurface
This action gets the surface being trimmed.
$tsurf getQuilt
This action gets the quilt that contains this trim surface.
$tsurf getModel
This action gets the model that contains this trim surface.
$tsurf isolate
This action split the trim surface’s quilt and model so that this trim surface is in its own quilt and model.
Base type for all glyph types
Entity type
Base type for all database entities
Database surface type
Database trim surface type
Database quilt type
Database model type