Glyph
Version 7.22.2
About
Base Type
Global Types
General Types
Mode Types
Base Entity Type
Database Entity Types
Grid Entity Types
Source Entity Types
Segment Types
Connector Support Types
Domain Support Types
Block Support Types
Utilities
Cadence Design Systems, Inc.

pw:: CutPlane

Persistent cut plane type

Derives From

pw::Object

Summary
pw:: CutPlane
Persistent cut plane type
Static Actions
create
This action creates a new cut plane object.
getAll
This action returns all of the currently defined cut planes.
isValidMetric
This action checks to see if the specified examine function is valid for use with the cut planes.
applyMetric
This action applies a block metric function name to the cuts.
getMetric
This function returns the current block metric used by pw::CutPlane objects.
refresh
This action runs the default metric function on any blocks cut by pw::CutPlane objects and updates the display of the cut planes.
getByName
This action returns returns a pw::CutPlane using the name.
Instance Actions
delete
This action deletes this cut plane.
getPlaneType
This action returns whether the cutting plane type is a physical or computational type.
setPointNormal
This action defines the cut plane as a plane centered on the given point with the specified normal.
setConstant
This action defines the cut plane as either a constant X, Y, Z, I, J, or K value.
setCoefficients
This function specifies the cutting plane via the coefficients of the plane equation Ax + By + Cz + D = 0.
setPoints
This action sets the cutting plane by giving three points that plane will pass through.
setPlane
This action defines the cutting plane via the result of any of the pwu::Plane definition methods.
getPlaneNormal
For physical cutting planes, this returns the plane normal.
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).
getPlaneCenter
This routine gets the center point on the plane if a physical plane is defined.
getPlane
This action gets the plane coefficients if the plane is a physical plane.
setComputationalPlane
This method defines the cutting plane as a computational plane at a specified constant computational axis.
getComputationalPlaneDirection
If the plane is defined as a computational plane, this returns the const computational direction (either “I”, “J”, or “K”).
getComputationalPlaneIndex
This action gets the constant index of the computational plane.
getCuts
This action returns the individual cut objects associated with this cut plane.
getCut
This function returns the cut object corresponding to the intersection of this cut plane through the specified block.
setForm
This action sets the cutting form for physical cuts.
getForm
This action returns the cutting form of the cutting plane.
getFrameworkPath
This function returns the path to the framework instance in which the cutting plane resides.
setRenderAttribute
This action sets the fill and line render attributes for the cutting plane’s cut objects.
getRenderAttribute
This action gets the cut plane’s fill and line render attributes.
setShrinkFactor
This action specifies the shrink factor to use for each displayed element in the cut plane’s cut objects.
getShrinkFactor
This action returns the shrink factor specified for the cut plane.
setName
This function sets the cut plane name.
getName
This function returns the name of the cutting plane.
setEnabled
This function controls whether or not the cutting plane is displayed.
getEnabled
This function returns whether or not the cutting plane is enabled.
addBlock
This action specifies a block or list of blocks to be intersected by the cutting plane.
removeBlock
This action removes a block from the cutting plane and deletes the corresponding pw::Cut object.
getBlocks
This method returns a list of the blocks the cutting plane is monitoring.
setExtremaMode
This action controls whether or not the cutting plane repositions its cut objects in each block such that they intersect the minimum or maximum value.
getExtremaMode
This method returns the current extrema setting for the cut plane group.
setTransparency
This action sets the transparency level for the cut plane’s current and future cuts.
getTransparency
This action returns the transparency setting for the cut plane group.
setOversetRenderAttribute
This action sets the overset render attributes for the cutting plane’s cut objects.
getOversetRenderAttribute
This action returns the overset render attributes for the cutting plane.
resetRenderAttributes
This action resets the various display settings of a cut to their default values.
Render Attributes
FillMode
This attribute is the fill mode for rendering a cut object.
LineMode
This attribute is the line mode for rendering a cut object.
Overset Render Attributes
FringeOption
This attribute controls how fringe information is displayed.
ShowHoleGrid
This attribute controls whether cells identified as holes by the IBLANK array are displayed.
ShowHoleSymbol
This attribute determines if a dot is drawn at the center of each cell identified as a hole by the IBLANK array.
ShowOrphans
This attribute controls if orphan objects are rendered for the cut plane group.
ShowOrphanDonorCandidates
This attribute controls if orphan donor objects are displayed for the cut plane group.

Static Actions

create

pw::CutPlane create

This action creates a new cut plane object.

Parameters

This action has no parameters.

Returns

This actions returns a new pw::CutPlane object.

Example

This examples shows how to create a persistent cut plane through two blocks at X=5.

Code

set cut [pw::CutPlane create]
$cut setConstant -X 5.0
$cut setForm Cells
$cut addBlock [pw::Grid getByName "blk-1"]
$cut addBlock [pw::Grid getByName "blk-2"]

getAll

pw::CutPlane getAll

This action returns all of the currently defined cut planes.  Cut planes from all framework paths are returned.

Parameters

This action has no parameters.

Returns; This action returns a list of pw::CutPlane objects.

isValidMetric

pw::CutPlane isValidMetric metric

This action checks to see if the specified examine function is valid for use with the cut planes.  In order to be valid, an examine function has to support either structured, unstructured, or extruded blocks and not be voxel-based.

Parameters

metricThis argument specifies the name of the string metric function to use.  See pw::Examine.create for the superset of options.

Returns; This function returns a boolean value indicating whether or not the metric function is valid for use with cut planes.

Notes

This function does not check to see if the function works with the specific block types currently cut by the cut planes.  For example, BlockLengthI is a valid metric even if no structured blocks are cut (or even present).

applyMetric

pw::CutPlane applyMetric

This action applies a block metric function name to the cuts.

Parameters

metricThis string argument specifies the block metric function to apply to the blocks cut by the pw::CutPlane objects.  The cut planes are re-evaluated with the new metric.

Returns

This action returns nothing.

getMetric

pw::CutPlane getMetric

This function returns the current block metric used by pw::CutPlane objects.

Parameters

None

Returns

This action returns a string value representing the metric function used by pw::CutPlane objects.

refresh

pw::CutPlane refresh ? -force ?

This action runs the default metric function on any blocks cut by pw::CutPlane objects and updates the display of the cut planes.  The default metric function is specified by pw::CutPlane.applyMetric.

Parameters

-forceForces the metric to be rerun even if the blocks have not changed since the last refresh.

Returns

This action has no return value.

getByName

pw::CutPlane getByName name

This action returns returns a pw::CutPlane using the name.

Parameters

nameThis parameter is a name string.

Returns

This actions returns a pw::CutPlane object.

Instance Actions

delete

$cutPlane delete

This action deletes this cut plane.  The cut plane’s pw::Cut objects will be deleted as well.

Parameters

None.

Returns

This action returns nothing.

getPlaneType

$cutPlane 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”.

setPointNormal

$cutPlane setPointNormal $point $normal

This action defines the cut plane as a plane centered on the given point with the specified normal.  This is categorized as a physical cut.

Parameters

pointThis argument should be a vector value specifying a point on the cutting plane.
normalThis parameter should be a vector value specifying the plane normal.

Returns

This action does not return anything.

setConstant

$cutPlane setConstant < -X | -Y | -Z | -I | -J | -K > value

This action defines the cut plane as either a constant X, Y, Z, I, J, or K value.  The first three types are categorized as physical cuts while the latter three are computational cuts.

Parameters

-XThis flag indicates the plane will represent a physical plane with a constant X value.
-YThis flag indicates the plane will represent a physical plane with a constant Y value.
-ZThis flag indicates the plane will represent a physical plane with a constant Z value.
-IThis flag indicates the plane will represent a computational plane with a constant I value.  It is relevant for structured blocks only.
-JThis flag indicates the plane will represent a computational plane with a constant J value.  It is relevant for structured blocks only.
-KThis flag indicates the plane will represent a computational plane with a constant K value.  It is relevant for structured and extruded blocks only.
valueThis argument specifies the constant value.  It should be a real value for a constant X, Y, or Z plane, and an unsigned integer value for a constant I, J, or K plane.

Returns

This function returns nothing.

setCoefficients

$cutPlane setCoefficients A B C D

This function specifies the cutting plane via the coefficients of the plane equation Ax + By + Cz + D = 0.  This plane type is categorized as a physical cut.

Parameters

AThis parameter is the first coefficient.
BThis parameter is the second coefficient.
CThis parameter is the third coefficient.
DThis parameter is the fourth coefficient.

Returns

This action returns nothing.

setPoints

$cutPlane setPoints point1 point2 point3

This action sets the cutting plane by giving three points that plane will pass through.  This plane type is categorized as a physical cut.

Parameters

point1This parameter is a point the plane will pass through.
point2This parameter is a point the plane will pass through.
point3This parameter is a point the plane will pass through.

Returns

This action returns nothing.

setPlane

$cutPlane setPlane $plane_coeffs

This action defines the cutting plane via the result of any of the pwu::Plane definition methods.

Parameters

plane_coeffsThis argument is a list of four float value defining the coefficients of the plane equation Ax + By + Cz = D.  Note that this is different from the equation used in pw::CutPlane.setCoefficients.  It reflects the value used by the pwu::Plane methods.

Returns

This action returns nothing.

getPlaneNormal

$cutPlane 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

$cutPlane 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

$cutPlane 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.

setComputationalPlane

$cutPlane setComputationalPlane computational_direction index

This method defines the cutting plane as a computational plane at a specified constant computational axis.

Parameters

computational_directionThis argument specifies the “I”, “J”, or “K” computational plane.
indexThis parameter specifies the constant index value for the computational plane.

Returns

This action returns nothing.

getComputationalPlaneDirection

$cutPlane 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

$cutPlane 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.

getCuts

$cutPlane getCuts

This action returns the individual cut objects associated with this cut plane.  Each cut will correspond to a different block.

Parameters

None.

Returns

This actions returns a list of pw::Cut objects.

getCut

$cutPlane getCut $block

This function returns the cut object corresponding to the intersection of this cut plane through the specified block.

Parameters

blockThis argument specifies the block of interest.

Returns

This action returns a pw::Cut object.

setForm

$cut setForm < Cells | Crinkle | Flat >

This action sets the cutting form for physical cuts.

Parameters

formThis argument specifies the cutting form.  Valid values are “Cell”, “Crinkle”, and “Flat”.

Notes

This routine has no effect for computational cutting planes.

Returns

This action returns nothing.

getForm

$cutPlane getForm

This action returns the cutting form of the cutting plane.

Parameters

None.

Returns

This routine returns a string value representing the cutting plane form.  The value with either be “Cells”, “Crinkle”, or “Flat”.  For computational cutting planes, the form will always be “Flat”.

getFrameworkPath

$cutPlane getFrameworkPath

This function returns the path to the framework instance in which the cutting plane resides.

Parameters

None.

Returns

This action returns list of pw::Framework objects defining the framework path to the cutting plane.

setRenderAttribute

$cutPlane setRenderAttribute < FillMode | LineMode > value

This action sets the fill and line render attributes for the cutting plane’s cut objects.

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

$cutPlane getRenderAttribute < FillMode | LineMode >

This action gets the cut plane’s fill and line render attributes.  Note that the cut plane’s individual cuts may have different 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 plane’s cut objects.  This value is applied to all cut objects belonging to the cut plane.

Parameters

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

Returns

This action returns nothing.

getShrinkFactor

$cutPlane getShrinkFactor

This action returns the shrink factor specified for the cut plane.  Note that individual cut objects may have been overridden with different shrink factors.

Parameters

None.

Returns

This action returns the shrink factor as a float value.

setName

$cutPlane setName name

This function sets the cut plane name.

Parameters

nameThis parameter specifies the new name for the cutting plane.  If the name is not unique amongst the other pw::CutPlane objects, a dash and a number will be appended to make the name unique.

Returns

This action returns the new name (which may have been modified to make it unique).

getName

This function returns the name of the cutting plane.

Parameters

None.

Returns

This action returns the cutting plane’s name as a string value.  */

static Gci::Status obj_getName(GciParser &parser, GlyphCutPlane *glyph) { if (Gci::OK != parser.endOfArgs()) { parser.usageError(1, “”); return Gci::Error; } parser.setResultGgString(glyph->getGgCutPlaneGroup()->getName()); return Gci::OK; }

setEnabled

$cutPlane setEnabled boolean

This function controls whether or not the cutting plane is displayed.

Parameters

valueThis boolean value controls if the cutting plane is shown.  A true value results in the cutting plane being shown while a false value hides the cutting plane.

Returns

This action returns nothing.

getEnabled

$cutPlane getEnabled

This function returns whether or not the cutting plane is enabled.

Parameters

None.

Returns

This action returns a true value when the cutting plane is enabled (shown) and a false value when the cutting plane is disabled (hidden).

addBlock

$cutPlane addBlock $block

This action specifies a block or list of blocks to be intersected by the cutting plane.  If the cutting plane intersects a block, a new pw::Cut object will be generated.

Parameters

blockA pw::Block object or list of pw::Block objects specifying the block or blocks to be cut.

Returns

This action returns nothing.

removeBlock

$cutPlane removeBlock $block

This action removes a block from the cutting plane and deletes the corresponding pw::Cut object.

Parameters

blockThis pw::Block object specifies the block to no longer cut.

Returns

This action returns nothing.

getBlocks

$cutPlane getBlocks

This method returns a list of the blocks the cutting plane is monitoring.

Parameters

None.

Returns

This action returns a list of pw::Block objects the cutting plane is potentially cutting.

setExtremaMode

$cutPlane setExtremaMode < None | Minimum | Maximum >

This action controls whether or not the cutting plane repositions its cut objects in each block such that they intersect the minimum or maximum value.

Parameters

modeThis argument specifies either “None”, “Minimum”, or “Maximum”.  A value of “None” uses the actual definition of the cutting plane to determine the cut location.  A “Minimum” value specifies that each cut should be repositioned to intersect the minimum value.  A value of “Maximum” indicates that each cut should be repositioned to intersect the maximum value.

Returns

This action returns nothing.

Notes

If the extrema mode is enabled, physical cuts will retain the specified normal value, but will be moved to intersect the given extrema value.  For computational cuts, the index will be modified to have the cut include the extrema value.  If the extrema mode is “None” or no metric has been specified, the cuts will fallback to the specified plane definition.

getExtremaMode

$cutPlane getExtremaMode

This method returns the current extrema setting for the cut plane group.

Parameters

None.

Returns

This action returns a string value indicating whether the cut plane group is set to move individual cuts to the minimum (“Minimum”) or maximum (“Maximum”) extrema of a block or the cut plane group will not modify the position of the cuts (“None”).

setTransparency

$cutPlane setTransparency transparency

This action sets the transparency level for the cut plane’s current and future cuts.

Parameters

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

Returns

This action returns nothing.

getTransparency

$cutPlane getTransparency

This action returns the transparency setting for the cut plane group.

Parameters

None.

Returns

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

Note

The transparency level can be set on individual cuts, so the value returned by this action does not necessarily reflect the value on each individual cut.

setOversetRenderAttribute

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

This action sets the overset render attributes for the cutting plane’s cut objects.

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

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

This action returns the overset render attributes for the cutting plane.

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

$cutPlane 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

$cutPlane 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

$cutPlane 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 marked 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

$cutPlane 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

$cutPlane 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

$cutPlane 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

$cutPlane 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
© 2021 Cadence Design Systems, Inc. All rights reserved worldwide.  Generated by Natural Docs.
pw::CutPlane create
This action creates a new cut plane object.
pw::CutPlane getAll
This action returns all of the currently defined cut planes.
pw::CutPlane isValidMetric metric
This action checks to see if the specified examine function is valid for use with the cut planes.
pw::CutPlane applyMetric
This action applies a block metric function name to the cuts.
pw::CutPlane getMetric
This function returns the current block metric used by pw::CutPlane objects.
Persistent cut plane type
pw::CutPlane refresh ? -force ?
This action runs the default metric function on any blocks cut by pw::CutPlane objects and updates the display of the cut planes.
pw::CutPlane getByName name
This action returns returns a pw::CutPlane using the name.
$cutPlane delete
This action deletes this cut plane.
$cutPlane getPlaneType
This action returns whether the cutting plane type is a physical or computational type.
$cutPlane setPointNormal $point $normal
This action defines the cut plane as a plane centered on the given point with the specified normal.
$cutPlane setConstant < -X | -Y | -Z | -I | -J | -K > value
This action defines the cut plane as either a constant X, Y, Z, I, J, or K value.
$cutPlane setCoefficients A B C D
This function specifies the cutting plane via the coefficients of the plane equation Ax + By + Cz + D = 0.
$cutPlane setPoints point1 point2 point3
This action sets the cutting plane by giving three points that plane will pass through.
$cutPlane setPlane $plane_coeffs
This action defines the cutting plane via the result of any of the pwu::Plane definition methods.
Utility functions for planes, which are represented as a list of four real values (the A, B, C and D coeffecients).
$cutPlane getPlaneNormal
For physical cutting planes, this returns the plane normal.
$cutPlane 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).
$cutPlane getPlane ?-D?
This action gets the plane coefficients if the plane is a physical plane.
$cutPlane setComputationalPlane computational_direction index
This method defines the cutting plane as a computational plane at a specified constant computational axis.
$cutPlane getComputationalPlaneDirection
If the plane is defined as a computational plane, this returns the const computational direction (either “I”, “J”, or “K”).
$cutPlane getComputationalPlaneIndex
This action gets the constant index of the computational plane.
$cutPlane getCuts
This action returns the individual cut objects associated with this cut plane.
$cutPlane getCut $block
This function returns the cut object corresponding to the intersection of this cut plane through the specified block.
$cut setForm < Cells | Crinkle | Flat >
This action sets the cutting form for physical cuts.
$cutPlane getForm
This action returns the cutting form of the cutting plane.
$cutPlane getFrameworkPath
This function returns the path to the framework instance in which the cutting plane resides.
$cutPlane setRenderAttribute < FillMode | LineMode > value
This action sets the fill and line render attributes for the cutting plane’s cut objects.
$cutPlane getRenderAttribute < FillMode | LineMode >
This action gets the cut plane’s fill and line render attributes.
$cutPlane getShrinkFactor
This action returns the shrink factor specified for the cut plane.
$cutPlane setName name
This function sets the cut plane name.
$cutPlane setEnabled boolean
This function controls whether or not the cutting plane is displayed.
$cutPlane getEnabled
This function returns whether or not the cutting plane is enabled.
$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.
Persistent cut type.
$cutPlane getBlocks
This method returns a list of the blocks the cutting plane is monitoring.
$cutPlane setExtremaMode < None | Minimum | Maximum >
This action controls whether or not the cutting plane repositions its cut objects in each block such that they intersect the minimum or maximum value.
$cutPlane getExtremaMode
This method returns the current extrema setting for the cut plane group.
$cutPlane setTransparency transparency
This action sets the transparency level for the cut plane’s current and future cuts.
$cutPlane getTransparency
This action returns the transparency setting for the cut plane group.
$cutPlane setOversetRenderAttribute < FringeOption | ShowHoleGrid | ShowHoleSymbol | ShowOrphans | ShowOrphanDonorCandidates > value
This action sets the overset render attributes for the cutting plane’s cut objects.
$cutPlane getOversetRenderAttribute < FringeOption | ShowHoleGrid | ShowHoleSymbol | ShowOrphans | ShowOrphanDonorCandidates >
This action returns the overset render attributes for the cutting plane.
$cut resetRenderAttributes
This action resets the various display settings of a cut to their default values.
$cutPlane get/setRenderAttribute FillMode mode
This attribute is the fill mode for rendering a cut object.
$cutPlane get/setRenderAttribute LineMode mode
This attribute is the line mode for rendering a cut object.
$cutPlane get/setOversetRenderAttribute FringeOption mode
This attribute controls how fringe information is displayed.
$cutPlane get/setOversetRenderAttribute ShowHoleGrid mode
This attribute controls whether cells identified as holes by the IBLANK array are displayed.
$cutPlane 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.
$cutPlane get/setOversetRenderAttribute ShowOrphans mode
This attribute controls if orphan objects are rendered for the cut plane group.
$cutPlane get/setOversetRenderAttribute ShowOrphanDonorCandidates mode
This attribute controls if orphan donor objects are displayed for the cut plane group.
Base type for all glyph types
A string is an array of characters.
pw::Examine create type
This action creates an examine object.
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.
A vector is a list of float values.
A float is a fractional number.
An integer is a whole number.
Framework type
A block is a volume grid bounded by one or more pw::Faces.
This action specifies the shrink factor to use for each displayed element in the cut plane’s cut objects.