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.
pw:: | Persistent cut type. |
Instance Actions | |
getCutPlane | This action returns the owning pw::CutPlane object. |
getPlaneType | This action returns whether the cutting plane type is a physical or computational type. |
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. |
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. |
getBlock | This method returns the block associated with the cut. |
setRenderAttribute | This action sets the fill and line render attributes for the cut. |
getRenderAttribute | This action gets the cut’s fill and line render attributes. |
setShrinkFactor | This action specifies the shrink factor to use for each displayed element in the cut. |
getShrinkFactor | This action returns the shrink factor specified for the cut. |
setTransparency | This action sets the transparency level for the cut. |
getTransparency | This action returns the transparency setting for the cut. |
setOversetRenderAttribute | This action sets the overset render attributes for the cut. |
getOversetRenderAttribute | This action returns the overset render attributes for the cut. |
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. |
$cut getCutPlane
This action returns the owning pw::CutPlane object.
None.
This action returns the pw::CutPlane object that controls this cut.
$cut getPlaneType
This action returns whether the cutting plane type is a physical or computational type.
None.
This function returns a string result of either “Physical” or “Computational”.
$cut getPlaneNormal
For physical cutting planes, this returns the plane normal. This action raises an error if the cutting plane type is computational.
None.
This action returns the plane normal as a vector value if the plane is categorized as a physical plane. It raises an error otherwise.
$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.
None.
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.
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.
None.
This action returns the center value as a vector.
$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.
-D | If 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. |
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.
$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.
None.
This function returns the constant computational axis: “I”, “J”, or “K”.
$cut getComputationalPlaneIndex
This action gets the constant index of the computational plane. An error is raised if this is a physical plane.
None.
This action returns the computational plane index as an integer value.
$cut getBlock
This method returns the block associated with the cut.
None.
This actions returns the pw::Block object associated with the cut.
$cut setRenderAttribute < FillMode | LineMode > value
This action sets the fill and line render attributes for the cut.
attribute | This string value is the name of the attribute to set. |
value | This string value is the attribute setting. |
This action returns nothing.
This action specifies the shrink factor to use for each displayed element in the cut.
factor | This float value specifies the shrink factor from 0.0 (full shrink) to 1.0 (no shrinking). |
This action returns nothing.
$cut getShrinkFactor
This action returns the shrink factor specified for the cut.
None.
This action returns the shrink factor as a float value.
$cut setTransparency transparency
This action sets the transparency level for the cut.
transparency | This parameter is a float value between 0 (fully opaque) and 1 (fully transparent) inclusive. |
This action returns nothing.
$cut getTransparency
This action returns the transparency setting for the cut.
None.
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.
$cut setOversetRenderAttribute < FringeOption | ShowHoleGrid | ShowHoleSymbol | ShowOrphans | ShowOrphanDonorCandidates > value
This action sets the overset render attributes for the cut.
attribute | This string value is the name of the attribute to set. |
value | This string value is the attribute setting. |
This action returns nothing.
FringeOption, ShowHoleGrid, ShowHoleSymbol, ShowOrphans, ShowOrphanDonorCandidates
$cut getOversetRenderAttribute < FringeOption | ShowHoleGrid | ShowHoleSymbol | ShowOrphans | ShowOrphanDonorCandidates >
This action returns the overset render attributes for the cut.
attribute | This string value is the name of the attribute to set. |
This action returns a string representing the value of the specified attribute.
FringeOption, ShowHoleGrid, ShowHoleSymbol, ShowOrphans, ShowOrphanDonorCandidates
$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.
None.
This action returns nothing.
setRenderAttribute, setOversetRenderAttribute, setShrinkFactor, setTransparency
$cut get/setRenderAttribute FillMode mode
This attribute is the fill mode for rendering a cut object.
string; < None | Flat | Shaded | HiddenLine >
None | Cell polygons are drawn as lines. |
Flat | Render the polygon interior filled with a constant, non-gradient color. This produces a flat, uncontoured appearance. |
Shaded | The cut cell polygons are filled with a color that varies based on the angle of its normal with the lighting direction and viewing direction. |
HiddenLine | Similar to Flat except that the fill color is the average of the background colors. This produces a hidden-line appearance. |
$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.
string; < All | None >
None | No outlines are drawn. |
All | The outlines of each polygon in the cut are drawn. |
$cut get/setOversetRenderAttribute FringeOption mode
This attribute controls how fringe information is displayed.
string; < Off | FringeOnly | FringeDonors >
Off | No fringe information is displayed. |
FringeOnly | Fringe cells are marked with a small dot at the cell center. |
FringeDonors | Fringe cells are marked with a small dot at the cell center and the fringe donors are draw in wireframe mode. |
ShowHoleGrid, ShowHoleSymbol, ShowOrphans, ShowOrphanDonorCandidates, setOversetRenderAttribute, getOversetRenderAttribute
$cut get/setOversetRenderAttribute ShowHoleGrid mode
This attribute controls whether cells identified as holes by the IBLANK array are displayed.
boolean; < false | true >
false | Cells identified as holes by the IBLANK array are not displayed. |
true | All cells in the cut plane are displayed. |
FringeOption, ShowHoleSymbol, ShowOrphans, ShowOrphanDonorCandidates, setOversetRenderAttribute, getOversetRenderAttribute
$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.
boolean; < false | true >
false | No dot is displayed at hole cell centers. |
true | A dot is displayed at hole cell centers. |
FringeOption, ShowHoleGrid, ShowOrphans, ShowOrphanDonorCandidates, setOversetRenderAttribute, getOversetRenderAttribute
$cut get/setOversetRenderAttribute ShowOrphans mode
This attribute controls if orphan objects are rendered for the cut plane group.
boolean; < false | true >
false | The orphan objects are not displayed. |
true | The orphan objects are displayed. |
FringeOption, ShowHoleGrid, ShowHoleSymbol, ShowOrphanDonorCandidates, setOversetRenderAttribute, getOversetRenderAttribute
$cut get/setOversetRenderAttribute ShowOrphanDonorCandidates mode
This attribute controls if orphan donor objects are displayed for the cut plane group.
boolean; < false | true >
false | No orphan donor objects are displayed. |
true | Orphan donor objects are displayed in a wireframe manner, colored by the donating block. |
FringeOption, ShowHoleGrid, ShowHoleSymbol, ShowOrphans, setOversetRenderAttribute, getOversetRenderAttribute
This action returns the owning pw::CutPlane object.
$cut getCutPlane
This action returns whether the cutting plane type is a physical or computational type.
$cut getPlaneType
For physical cutting planes, this returns the plane normal.
$cut getPlaneNormal
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 getPlaneDistance
This action gets the plane coefficients if the plane is a physical plane.
$cut getPlane ?-D?
If the plane is defined as a computational plane, this returns the const computational direction (either “I”, “J”, or “K”).
$cut getComputationalPlaneDirection
This action gets the constant index of the computational plane.
$cut getComputationalPlaneIndex
This method returns the block associated with the cut.
$cut getBlock
This action sets the fill and line render attributes for the cut.
$cut setRenderAttribute < FillMode | LineMode > value
This action gets the cut’s fill and line render attributes.
$cut getRenderAttribute < FillMode | LineMode >
This action returns the shrink factor specified for the cut.
$cut getShrinkFactor
This action sets the transparency level for the cut.
$cut setTransparency transparency
This action returns the transparency setting for the cut.
$cut getTransparency
This action sets the overset render attributes for the cut.
$cut setOversetRenderAttribute < FringeOption | ShowHoleGrid | ShowHoleSymbol | ShowOrphans | ShowOrphanDonorCandidates > value
This action returns the overset render attributes for the cut.
$cut getOversetRenderAttribute < FringeOption | ShowHoleGrid | ShowHoleSymbol | ShowOrphans | ShowOrphanDonorCandidates >
This action resets the various display settings of a cut to their default values.
$cut resetRenderAttributes
This attribute is the fill mode for rendering a cut object.
$cut get/setRenderAttribute FillMode mode
This attribute is the line mode for rendering a cut object.
$cut get/setRenderAttribute LineMode mode
This attribute controls how fringe information is displayed.
$cut get/setOversetRenderAttribute FringeOption mode
This attribute controls whether cells identified as holes by the IBLANK array are displayed.
$cut get/setOversetRenderAttribute ShowHoleGrid 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 ShowHoleSymbol mode
This attribute controls if orphan objects are rendered for the cut plane group.
$cut get/setOversetRenderAttribute ShowOrphans mode
This attribute controls if orphan donor objects are displayed for the cut plane group.
$cut get/setOversetRenderAttribute ShowOrphanDonorCandidates mode
This action specifies a block or list of blocks to be intersected by the cutting plane.
$cutPlane addBlock $block
This action removes a block from the cutting plane and deletes the corresponding pw::Cut object.
$cutPlane removeBlock $block