pw:: Cut

Persistent cut type.  Note that cut planes are created and destroyed by pw::CutPlane objects via the pw::CutPlane.addBlock and pw::CutPlane.removeBlock methods.

Derives From

pw::Object

Summary
Persistent cut type.
This action returns the owning pw::CutPlane object.
This action returns whether the cutting plane type is a physical or computational type.
For physical cutting planes, this returns the plane normal.
For physical cutting planes, this returns the signed distance from the origin to the plane (the value of D in the plane equation Ax + By + Cz = D).
This routine gets the center point on the plane if a physical plane is defined.
This action gets the plane coefficients if the plane is a physical plane.
If the plane is defined as a computational plane, this returns the const computational direction (either “I”, “J”, or “K”).
This action gets the constant index of the computational plane.
This method returns the block associated with the cut.
This action sets the fill and line render attributes for the cut.
This action gets the cut’s fill and line render attributes.
This action specifies the shrink factor to use for each displayed element in the cut.
This action returns the shrink factor specified for the cut.
This action sets the transparency level for the cut.
This action returns the transparency setting for the cut.
This action sets the overset render attributes for the cut.
This action returns the overset render attributes for the cut.
This action resets the various display settings of a cut to their default values.
This attribute is the fill mode for rendering a cut object.
This attribute is the line mode for rendering a cut object.
This attribute controls how fringe information is displayed.
This attribute controls whether cells identified as holes by the IBLANK array are displayed.
This attribute determines if a dot is drawn at the center of each cell identified as a hole by the IBLANK array.
This attribute controls if orphan objects are rendered for the cut plane group.
This attribute controls if orphan donor objects are displayed for the cut plane group.

Instance Actions

getCutPlane

$cut getCutPlane

This action returns the owning pw::CutPlane object.

Parameters

None.

Returns

This action returns the pw::CutPlane object that controls this cut.

getPlaneType

$cut getPlaneType

This action returns whether the cutting plane type is a physical or computational type.

Parameters

None.

Returns

This function returns a string result of either “Physical” or “Computational”.

getPlaneNormal

$cut getPlaneNormal

For physical cutting planes, this returns the plane normal.  This action raises an error if the cutting plane type is computational.

Parameters

None.

Returns

This action returns the plane normal as a vector value if the plane is categorized as a physical plane.  It raises an error otherwise.

getPlaneDistance

$cut getPlaneDistance

For physical cutting planes, this returns the signed distance from the origin to the plane (the value of D in the plane equation Ax + By + Cz = D).  This action raises an error if the cutting plane type is computational.

Parameters

None.

Returns

This action returns the signed distance from the origin to the plane as a float value if the plane is categorized as a physical plane.  It raises an error if the plane is a computational plane.

getPlaneCenter

This routine gets the center point on the plane if a physical plane is defined.  An error is raised if this is a computational plane.

Parameters

None.

Returns

This action returns the center value as a vector.

getPlane

$cut getPlane ?-D?

This action gets the plane coefficients if the plane is a physical plane.  It raises an error if the plane is a computational plane.

Parameters

-DIf specified, the coefficients correspond to the equation Ax + By + Cz = D, which matches the pwu::Plane format.  If not specified, the coefficients correspond to the Ax + By + Cz + D = 0 equation.

Returns

This action returns the plane as list of 4 coefficients.  If the -D option is specified, the result can be treated as a pwu::Plane object.

getComputationalPlaneDirection

$cut getComputationalPlaneDirection

If the plane is defined as a computational plane, this returns the const computational direction (either “I”, “J”, or “K”).  If this is a physical cutting plane, an error is raised.

Parameters

None.

Returns

This function returns the constant computational axis: “I”, “J”, or “K”.

getComputationalPlaneIndex

$cut getComputationalPlaneIndex

This action gets the constant index of the computational plane.  An error is raised if this is a physical plane.

Parameters

None.

Returns

This action returns the computational plane index as an integer value.

getBlock

$cut getBlock

This method returns the block associated with the cut.

Parameters

None.

Returns

This actions returns the pw::Block object associated with the cut.

setRenderAttribute

$cut setRenderAttribute < FillMode | LineMode > value

This action sets the fill and line render attributes for the cut.

Parameters

attributeThis string value is the name of the attribute to set.
valueThis string value is the attribute setting.

Returns

This action returns nothing.

See Also

FillMode, LineMode

getRenderAttribute

$cut getRenderAttribute < FillMode | LineMode >

This action gets the cut’s fill and line render attributes.

Parameters

attributeThis string value is the name of the attribute to query.

Returns

This action returns a string representing the value of the queried attribute.

See Also

FillMode, LineMode

setShrinkFactor

This action specifies the shrink factor to use for each displayed element in the cut.

Parameters

factorThis float value specifies the shrink factor from 0.0 (full shrink) to 1.0 (no shrinking).

Returns

This action returns nothing.

getShrinkFactor

$cut getShrinkFactor

This action returns the shrink factor specified for the cut.

Parameters

None.

Returns

This action returns the shrink factor as a float value.

setTransparency

$cut setTransparency transparency

This action sets the transparency level for the cut.

Parameters

transparencyThis parameter is a float value between 0 (fully opaque) and 1 (fully transparent) inclusive.

Returns

This action returns nothing.

getTransparency

$cut getTransparency

This action returns the transparency setting for the cut.

Parameters

None.

Returns

This action returns a float value between 0 and 1 inclusive.  A value of 0 means the cut is set to fully opaque, while a value of 1 indicates the cut is set to fully transparent.

setOversetRenderAttribute

$cut setOversetRenderAttribute < FringeOption | ShowHoleGrid | ShowHoleSymbol | ShowOrphans | ShowOrphanDonorCandidates > value

This action sets the overset render attributes for the cut.

Parameters

attributeThis string value is the name of the attribute to set.
valueThis string value is the attribute setting.

Returns

This action returns nothing.

See Also

FringeOption, ShowHoleGrid, ShowHoleSymbol, ShowOrphans, ShowOrphanDonorCandidates

getOversetRenderAttribute

$cut getOversetRenderAttribute < FringeOption | ShowHoleGrid | ShowHoleSymbol | ShowOrphans | ShowOrphanDonorCandidates >

This action returns the overset render attributes for the cut.

Parameters

attributeThis string value is the name of the attribute to set.

Returns

This action returns a string representing the value of the specified attribute.

See Also

FringeOption, ShowHoleGrid, ShowHoleSymbol, ShowOrphans, ShowOrphanDonorCandidates

resetRenderAttributes

$cut resetRenderAttributes

This action resets the various display settings of a cut to their default values.  This includes the FillMode, the LineMode, the transparency, the shrink factor, and the overset render attributes.

Parameters

None.

Returns

This action returns nothing.

See Also

setRenderAttribute, setOversetRenderAttribute, setShrinkFactor, setTransparency

Render Attributes

FillMode

$cut get/setRenderAttribute FillMode mode

This attribute is the fill mode for rendering a cut object.

Type

string; < None | Flat | Shaded | HiddenLine >

Information

NoneCell polygons are drawn as lines.
FlatRender the polygon interior filled with a constant, non-gradient color.  This produces a flat, uncontoured appearance.
ShadedThe cut cell polygons are filled with a color that varies based on the angle of its normal with the lighting direction and viewing direction.
HiddenLineSimilar to Flat except that the fill color is the average of the background colors.  This produces a hidden-line appearance.

See Also

LineMode, setRenderAttribute, getRenderAttribute

LineMode

$cut get/setRenderAttribute LineMode mode

This attribute is the line mode for rendering a cut object.  This setting only applies when the fill mode is set to Flat or Shaded.

Type

string; < All | None >

Information

NoneNo outlines are drawn.
AllThe outlines of each polygon in the cut are drawn.

See Also

FillMode, setRenderAttribute, getRenderAttribute

Overset Render Attributes

FringeOption

$cut get/setOversetRenderAttribute FringeOption mode

This attribute controls how fringe information is displayed.

Type

string; < Off | FringeOnly | FringeDonors >

Information

OffNo fringe information is displayed.
FringeOnlyFringe cells are marked with a small dot at the cell center.
FringeDonorsFringe cells are mared with a small dot at the cell center and the fringe donors are draw in wireframe mode.

See Also

ShowHoleGrid, ShowHoleSymbol, ShowOrphans, ShowOrphanDonorCandidates, setOversetRenderAttribute, getOversetRenderAttribute

ShowHoleGrid

$cut get/setOversetRenderAttribute ShowHoleGrid mode

This attribute controls whether cells identified as holes by the IBLANK array are displayed.

Type

boolean; < false | true >

Information

falseCells identified as holes by the IBLANK array are not displayed.
trueAll cells in the cut plane are displayed.

See Also

FringeOption, ShowHoleSymbol, ShowOrphans, ShowOrphanDonorCandidates, setOversetRenderAttribute, getOversetRenderAttribute

ShowHoleSymbol

$cut get/setOversetRenderAttribute ShowHoleSymbol mode

This attribute determines if a dot is drawn at the center of each cell identified as a hole by the IBLANK array.

Type

boolean; < false | true >

Information

falseNo dot is displayed at hole cell centers.
trueA dot is displayed at hole cell centers.

See Also

FringeOption, ShowHoleGrid, ShowOrphans, ShowOrphanDonorCandidates, setOversetRenderAttribute, getOversetRenderAttribute

ShowOrphans

$cut get/setOversetRenderAttribute ShowOrphans mode

This attribute controls if orphan objects are rendered for the cut plane group.

Type

boolean; < false | true >

Information

falseThe orphan objects are not displayed.
trueThe orphan objects are displayed.

See Also

FringeOption, ShowHoleGrid, ShowHoleSymbol, ShowOrphanDonorCandidates, setOversetRenderAttribute, getOversetRenderAttribute

ShowOrphanDonorCandidates

$cut get/setOversetRenderAttribute ShowOrphanDonorCandidates mode

This attribute controls if orphan donor objects are displayed for the cut plane group.

Type

boolean; < false | true >

Information

falseNo orphan donor objects are displayed.
trueOrphan donor objects are displayed in a wireframe manner, colored by the donating block.

See Also

FringeOption, ShowHoleGrid, ShowHoleSymbol, ShowOrphans, setOversetRenderAttribute, getOversetRenderAttribute

$cut getCutPlane
This action returns the owning pw::CutPlane object.
Persistent cut plane type
$cut getPlaneType
This action returns whether the cutting plane type is a physical or computational type.
$cut getPlaneNormal
For physical cutting planes, this returns the plane normal.
$cut getPlaneDistance
For physical cutting planes, this returns the signed distance from the origin to the plane (the value of D in the plane equation Ax + By + Cz = D).
$cut getPlane ?-D?
This action gets the plane coefficients if the plane is a physical plane.
$cut getComputationalPlaneDirection
If the plane is defined as a computational plane, this returns the const computational direction (either “I”, “J”, or “K”).
$cut getComputationalPlaneIndex
This action gets the constant index of the computational plane.
$cut getBlock
This method returns the block associated with the cut.
$cut setRenderAttribute < FillMode | LineMode > value
This action sets the fill and line render attributes for the cut.
$cut getRenderAttribute < FillMode | LineMode >
This action gets the cut’s fill and line render attributes.
$cut getShrinkFactor
This action returns the shrink factor specified for the cut.
$cut setTransparency transparency
This action sets the transparency level for the cut.
$cut getTransparency
This action returns the transparency setting for the cut.
$cut setOversetRenderAttribute < FringeOption | ShowHoleGrid | ShowHoleSymbol | ShowOrphans | ShowOrphanDonorCandidates > value
This action sets the overset render attributes for the cut.
$cut getOversetRenderAttribute < FringeOption | ShowHoleGrid | ShowHoleSymbol | ShowOrphans | ShowOrphanDonorCandidates >
This action returns the overset render attributes for the cut.
$cut resetRenderAttributes
This action resets the various display settings of a cut to their default values.
$cut get/setRenderAttribute FillMode mode
This attribute is the fill mode for rendering a cut object.
$cut get/setRenderAttribute LineMode mode
This attribute is the line mode for rendering a cut object.
$cut get/setOversetRenderAttribute FringeOption mode
This attribute controls how fringe information is displayed.
$cut get/setOversetRenderAttribute ShowHoleGrid mode
This attribute controls whether cells identified as holes by the IBLANK array are displayed.
$cut get/setOversetRenderAttribute ShowHoleSymbol mode
This attribute determines if a dot is drawn at the center of each cell identified as a hole by the IBLANK array.
$cut get/setOversetRenderAttribute ShowOrphans mode
This attribute controls if orphan objects are rendered for the cut plane group.
$cut get/setOversetRenderAttribute ShowOrphanDonorCandidates mode
This attribute controls if orphan donor objects are displayed for the cut plane group.
$cutPlane addBlock $block
This action specifies a block or list of blocks to be intersected by the cutting plane.
$cutPlane removeBlock $block
This action removes a block from the cutting plane and deletes the corresponding pw::Cut object.
Base type for all glyph types
A string is an array of characters.
A vector is a list of float values.
A float is a fractional number.
Utility functions for planes, which are represented as a list of four real values (the A, B, C and D coeffecients).
An integer is a whole number.
Block type
This action specifies the shrink factor to use for each displayed element in the cut.
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.