pw:: FaceUnstructured

Unsuctured face type

Derives From

pw::Object pw::Face

Summary
Unsuctured face type
This action creates a new unstructured face object.
This command creates new unstructured face objects from the given domains.
This attribute is the maximum bending angle allowed when adding domains to this face, with 0 meaning no maximum.
This action gets the orientation of the face normals.
This action sets the orientation of the face normals.
This action gets domains adjacent to a face.
This action designates the face as a baffle or non-baffle face.
This action returns true if the face is a baffle face.

Static Actions

create

pw::FaceUnstructured create

This action creates a new unstructured face object.

Parameters

none

Returns

This action returns a new pw::FaceUnstructured object.

createFromDomains

pw::FaceUnstructured createFromDomains ?-single? domains

This command creates new unstructured face objects from the given domains.

Parameters

-singleIf this flag is present, this action tries to combine the domains into a single complete face.  If that is not possible, a block is created for each domain.
domainsThis parameter is a list of pw::Domain objects.

Notes

While this command will produce identical results when run with the exact same input, it may produce different results for slight variations in the input domains.  The faces may be created in a different order or may be created with different orientations or topologies.  Use the explicit face building routines (pw::FaceUnstructured.create and pw::Face.addDomain commands) to build the face in a controlled manner.

Returns

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

Static Attributes

MaximumBendAngle

pw::FaceUnstructured get/setMaximumBendAngle angle

This attribute is the maximum bending angle allowed when adding domains to this face, with 0 meaning no maximum.

Type

float [0, 180)

Default

0

Instance Actions

getNormalOrientation

$face getNormalOrientation

This action gets the orientation of the face normals.

Parameters

none

Returns

This action returns a string that is one of In | Out | Unknown.

setNormalOrientation

$face setNormalOrientation direction

This action sets the orientation of the face normals.

Parameters

directionThis parameter is the direction of the normals; < In | Out >.

Returns

This action returns the resulting direction.

getAdjacentDomains

$face getAdjacentDomains ?-includeSelf? ?-manifold? ?-maximumAngle angle? ?-nopoles? ?-type option? ?-visibleOnly?

This action gets domains adjacent to a face.

Parameters

-includeSelfThis optional parameter, if present, means to also include domains in the face that are along the edge.
-manifoldThis optional paramter indicates to restrict results to manifold domains (only 2 domains sharing a common connector).
-maximumAngle angleThis optional paramter specifies the maximum angle allowed between a domain and the face for the domain to be included.
-nopolesExcludes any domains that contain pole connectors.
-type optionThis optional parameter indicates to restrict the domain types returned.  Valid options are Structured, Unstructured, or Both (default).
-visibleOnlyThis flag, if present, restricts the results to only visible domains.

Returns

This action returns a list of domains adjacent to the face.

setBaffle

$face setBaffle value

This action designates the face as a baffle or non-baffle face.

Parameters

valueThis boolean parameter sets whether or not the face is a baffle face.

Returns

This action returns nothing.

isBaffle

$face isBaffle

This action returns true if the face is a baffle face.

Parameters

none

Returns

This action returns a boolean value of true if the face is a baffle face or false if the face is a non-baffle face.

pw::FaceUnstructured create
This action creates a new unstructured face object.
pw::FaceUnstructured createFromDomains ?-single? domains
This command creates new unstructured face objects from the given domains.
pw::FaceUnstructured get/setMaximumBendAngle angle
This attribute is the maximum bending angle allowed when adding domains to this face, with 0 meaning no maximum.
$face getNormalOrientation
This action gets the orientation of the face normals.
$face setNormalOrientation direction
This action sets the orientation of the face normals.
$face getAdjacentDomains ?-includeSelf? ?-manifold? ?-maximumAngle angle? ?-nopoles? ?-type option? ?-visibleOnly?
This action gets domains adjacent to a face.
$face setBaffle value
This action designates the face as a baffle or non-baffle face.
$face isBaffle
This action returns true if the face is a baffle face.
Base type for all glyph types
Unsuctured face type
Domain type
$face addDomain ?-linkage linkage? domain
This action adds a domain to this face.
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.