Grid shape type
pw:: | Grid shape type |
Static Actions | |
create | This action creates a new grid shape object. |
getEntitiesInBlock | This action returns the entities that would be used in a block when a grid shape has IncludeEnclosingEntitiesInBlock set to true and the given entities are the enclosing entities. |
Instance Attributes | |
Transform | This attribute is the geometric transform of the shape. |
Pivot | This attribute is the location of the transform pivot on the shape. |
SectionMinimum | This attribute is the sectional minimum angle in degrees of the shape, for shapes that support a sectional representation. |
SectionMaximum | This attribute is the sectional maximum angle in degrees of the shape, for shapes that support a sectional representation. |
BaseType | This attribute is the type of cap used at the base of the shape. |
TopType | This attribute is the type of cap used at the top of the shape. |
SidesType | This attribute is the type of cap used at the sides of the shape when it is a partial shape (e.g. |
GridType | This attribute is the type of grid that is generated from the shape. |
GridBoundary | This attribute is the boundary mode that determines the dimension and distribution of connectors and domains that are generated from the shape. |
IgnoreAllSources | This attribute is a flag that controls whether the influence of sources should be ignored when a size field is generated for this entity. |
IgnoreAllSizeFieldEntities | This attribute is a flag that controls whether the influence of explicitly included entities should be ignored when a size field is generated for this entity. |
SizeFieldDecay | This attribute is the size field decay factor used as the decay when a size field is generated for this entity. |
SizeFieldBackgroundSpacing | This attribute is the size background spacing when a size field is generated for this entity. |
SizeFieldCalculationMethod | This attribute is a string that controls how spacing is calculated for size field point primitives. |
SizeFieldIgnoreEntityBoundary | This attribute controls whether the boundary of the entity should be ignored when the size field is generated for this entity. |
IncludeEnclosingEntitiesInBlock | This attribute controls whether the block generated from this shape should use the enclosing entities in the block’s face definition. |
SymmetryPlaneTolerance | This attribute is the tolerance to use when determining which connectors of the enclosed domains should be included in the symmetry plane domains constructed by this grid shape. |
Instance Actions | |
isDefined | This action checks if this shape is defined. |
isSolid | This action checks if this shape is solid |
isFaceValid | This action returns whether the given face is valid for the current configuration of the shape. |
getPosition | This action gets the position in the defining space of the shape at the given parameter. |
getXYZ | This action gets the position of the surface in model space at the given parameter. |
getCenterXYZ | This action gets the center of the shape in model space. |
getBaseXYZ | This action gets the base of the shape in model space. |
getTopXYZ | This action gets the top of the shape in model space. |
getObjectXYZ | This action gets the position of the surface in object space at the given parameter. |
getNormal | This action gets the normal of the surface in model space at the given parameter. |
setSectionQuadrants | This action sets the section minimum and maximum angles of the shape to either 1, 2, 3 or 4 quadrants. |
normalizeTransform | This action modifies the transform so that the minimum scale factor is set to one, and at the same time update the dimensions so the shape of the object remains unchanged. |
clear | This action clears the shape. |
sphere | This action sets the shape to a sphere. |
cylinder | This action sets the shape to a cylinder, cone or disk. |
box | This action sets the shape to a box, frustum or rectangle. |
polygon | This action sets the shape to a polygon. |
getPrimitive | This action gets the current primitive type string of this shape with values being < None | Sphere | Cylinder | Box | Polygon > |
getLength | This action gets the length parameter used to set the shape. |
getBaseAngle | This action gets the base angle parameter used to set the shape. |
getTopAngle | This action gets the top angle parameter used to set the shape. |
getRadius | This action gets the radius parameter used to set the shape. |
getTopRadius | This action gets the top radius parameter used to set the shape. |
getWidth | This action gets the width parameter used to set the shape. |
getTopWidth | This action gets the top width parameter used to set the shape. |
getHeight | This action gets the height parameter used to set the shape. |
getTopHeight | This action gets the top height parameter used to set the shape. |
getPoints | This action gets the points parameter used to set the shape. |
getSlope | This action gets the slope type string used for creating the shape. |
getSizeFieldSpacing | This action gets the minimum, average and maximum spacing of the size field associated with this shape. |
getEnclosingEntities | This action gets the enclosing entities associated with this shape. |
setEnclosingEntities | This action sets the enclosing entities associated with this grid shape. |
getEnclosingEntitiesSpacing | This action gets the minimum, average and maximum spacing of the enclosing entities associated with this shape. |
getExcludedSources | This action gets all source entities that are being explicitly excluded from affecting the grid generated by this shape |
excludeSource | This action explicitly excludes a source from affecting the grid generated by this shape |
getIncludedSizeFieldEntities | This action gets all entities that are being explicitly included in the size field that affects the grid generated by this shape |
includeSizeFieldEntity | This action explicitly includes an entity in the size field source that affects the grid generated by this shape |
clearSizeFieldEntities | This action clears all explicitly included entities in the size field source from affecting the grid generated by this shape |
getIncludedSizeFieldEntitiesSpacing | This action gets the minimum, average and maximum spacing of the explicitly included size field entities of this shape. |
delete | This action deletes the grid shape. |
updateGridEntities | This action creates or updates the grid entities associated with this grid shape. |
clearGridEntities | This action deletes the grid entities associated with this grid shape. |
getGridEntities | This action gets the grid entities currently associated with this grid shape. |
getBoundaryGridEntitiesSpacing | This action gets the minimum, average and maximum spacing of the boundary grid entities associated with this shape. |
getIncludedEntitiesInBlock | This action returns a list of pw::GridEntity objects that will be included in the block when the <IndcludeEntitiesInBlock> attribute is set to true. |
getBlockRegisters | This action gets the registers of the grid entities currently associated with this grid shape. |
getAutomaticBackgroundSpacing | This action gets the calculated boundary spacing that is used when the <BackgroundSpacing> attribute is set to 0.0. |
getVoxelMinimumSize | This action gets the calculated voxel minimum size for a newly created voxel block from this grid shape. |
getVoxelMaximumSize | This action gets the calculated voxel maximum size for a newly created voxel block from this grid shape. |
pw::GridShape create
This action creates a new grid shape object.
none
This action returns a new pw::GridShape object.
pw::GridShape getEntitiesInBlock enclosingEnts
This action returns the entities that would be used in a block when a grid shape has IncludeEnclosingEntitiesInBlock set to true and the given entities are the enclosing entities.
enclosingEnts | This parameter is a list of pw::Entity objects that a grid shape encloses. |
This action returns a list of pw::Entity objects that are a subset of the given enclosingEnts list that would be used in a block
$shape get/setPivot pivot
This attribute is the location of the transform pivot on the shape.
This attribute is a string with options < Base | Center | Top >.
Base
Base refers to the center of the shape’s base, Center refers to the center of the shape, and Top refers to the center of the shape’s top. The pivot location will have object coordinates of 0, 0, 0.
$shape get/setSectionMinimum angle
This attribute is the sectional minimum angle in degrees of the shape, for shapes that support a sectional representation.
This attribute is a float. Although there is no minimum or maximum value, the angle will be interpreted by mapping it to the range [0.0, 360.0).
The default for this attribute is 0.
$shape get/setSectionMaximum angle
This attribute is the sectional maximum angle in degrees of the shape, for shapes that support a sectional representation.
This attribute is a float. Although there is no minimum or maximum value, the angle will be interpreted by mapping it to the range (0.0, 360.0].
The default for this attribute is 360.
$shape get/setBaseType type
This attribute is the type of cap used at the base of the shape. Only some shapes (sphere and cylinder) support a cap type of sphere. For other shapes, if the cap type is set to Sphere, it will behave the same as if it were set to Plane.
This attribute is a string with options < Open | Plane | Sphere >.
The default for this attribute is Plane.
$shape get/setTopType type
This attribute is the type of cap used at the top of the shape. Only some shapes (sphere and cylinder) support a cap type of sphere. For other shapes, if the cap type is set to Sphere, it will behave the same as if it were set to Plane.
This attribute is a string with options < Open | Plane | Sphere >.
The default for this attribute is Plane.
$shape get/setSidesType type
This attribute is the type of cap used at the sides of the shape when it is a partial shape (e.g. a hemi sphere). Shapes that do not support partial specification (polygon) will ignore this attribute.
This attribute is a string with options < Open | Plane >.
The default for this attribute is Plane.
$shape get/setGridType type
This attribute is the type of grid that is generated from the shape. When calling updateGridEntities, this attribute will control what type of grid entities will be constructed.
This attribute is a string with options < Unstructured | Voxel | Structured >.
The default for this attribute is Unstructured.
$shape get/setGridBoundary mode
This attribute is the boundary mode that determines the dimension and distribution of connectors and domains that are generated from the shape. When calling updateGridEntities, this attribute will control how the boundary connectors and domains will be constructed.
This attribute is a string with options < FromDefaults | FromBackgroundSpacing | EnclosingEntitiesMinimumSpacing | EnclosingEntitiesAverageSpacing | EnclosingEntitiesMaximumSpacing | IncludedSizeFieldEntitiesMinimumSpacing | IncludedSizeFieldEntitiesAverageSpacing | IncludedSizeFieldEntitiesMaximumSpacing | SizeFieldMinimumSpacing | SizeFieldAverageSpacing | SizeFieldMaximumSpacing | FromSizeField >.
The default for this attribute is FromDefaults.
The dimension and distribution of connectors generated will be as follows:
The domains will be initialized as specified by the domain defaults. However, if this mode is FromSizeField, the domain’s interior points will also be adapted as specified locally by the size field.
$shape get/setSizeFieldDecay decay
This attribute is the size field decay factor used as the decay when a size field is generated for this entity. The size field will use this decay for entities added to the size field that don’t have a explicitly assigned decay.
This attribute is a float with the range [0, 1].
The default for this attribute is the value in the SizeFieldDecay default when the grid entity was created.
$shape get/setSizeFieldBackgroundSpacing spacing
This attribute is the size background spacing when a size field is generated for this entity.
This attribute is a float with the range [0, infinity).
The default for this attribute is the value in the SizeFieldBackgroundSpacing default when the grid entity was created.
$shape get/setSizeFieldCalculationMethod method
This attribute is a string that controls how spacing is calculated for size field point primitives.
This attribute is a string with options < MinimumDistance | InverseDistance | BlendDistance | MinimumValue >
The default for this attribute is MinimumDistance
$shape get/setSizeFieldIgnoreEntityBoundary ignore
This attribute controls whether the boundary of the entity should be ignored when the size field is generated for this entity.
This attribute is a boolean
The default for this attribute is false.
$shape get/setIncludeEnclosingEntitiesInBlock include
This attribute controls whether the block generated from this shape should use the enclosing entities in the block’s face definition.
This attribute is a boolean.
The default for this attribute is False.
This attribute is only applicable when the GridType attribute is set to Unstructured, and only the domains in the enclosing entities that are in the same framework as this grid shape’s framework will be included in the block’s faces.
$shape get/setSymmetryPlaneTolerance tol
This attribute is the tolerance to use when determining which connectors of the enclosed domains should be included in the symmetry plane domains constructed by this grid shape.
This attribute is a float with the range [0, infinity).
The default for this attribute is 0.0, which denotes that the tolerance to use is the current value of pw::Grid.ConnectorTolerance attribute.
$shape isDefined
This action checks if this shape is defined.
This action has no parameters.
This action returns a boolean, true if the shape is defined.
$shape isSolid
This action checks if this shape is solid
This action has no parameters.
This action returns a boolean, true if the shape is solid
$shape isFaceValid face
This action returns whether the given face is valid for the current configuration of the shape.
face | This parameter is the part of the shape to check the validity of, with options < Main | Base | Top | MinimumSide | MaximumSide > or an integer in the range [1, 5], which corresponds to the options Main=1, Base=2, etc. |
This action returns a boolean with true if the face is valid and false if it is not
$shape getPosition ?< -parameter | -closest >? value
This action gets the position in the defining space of the shape at the given parameter.
-parameter | This optional flag indicates to get the position at a parameter. The value is a uv vector in the range [0.0, 1.0] followed by an optional face string with options < Main | Base | Top | MinimumSide | MaximumSide > or an integer in the range [1, 5], with 1=Main, 2=Base, etc. |
-closest | This optional flag results in calculating the position of the point on the shape closest to the specified value. value is a point, or grid coord. |
value | This parameter is the value at which to get the position. Its interpretation is determined by the above flags. The default mode is the -parameter flag. |
This action returns a point giving the position on the shape (may be in the form “u v dbentity”).
$shape getXYZ ?< -parameter | -closest >? value
This action gets the position of the surface in model space at the given parameter.
-parameter | This optional flag indicates to get the XYZ value at a parameter. The value is a uv vector in the range [0.0, 1.0] followed by an optional face string with options < Main | Base | Top | MinimumSide | MaximumSide > or an integer in the range [1, 5], with 1=Main, 2=Base, etc. |
-closest | This optional flag results in calculating the XYZ value of the point on the shape closest to the specified value. value is a point, or grid coord. |
value | This parameter is the value at which to get the XYZ value. Its interpretation is determined by the above flags. The default mode is the -parameter flag. |
This action returns an XYZ vector.
$shape getCenterXYZ
This action gets the center of the shape in model space.
This action takes no parameters.
This action returns an XYZ vector.
$shape getBaseXYZ
This action gets the base of the shape in model space.
This action takes no parameters.
This action returns an XYZ vector.
$shape getTopXYZ
This action gets the top of the shape in model space.
This action takes no parameters.
This action returns an XYZ vector.
$shape getObjectXYZ ?< -parameter | -closest >? value
This action gets the position of the surface in object space at the given parameter.
-parameter | This optional flag indicates to get the object space XYZ value at a parameter. The value is a uv vector in the range [0.0, 1.0] followed by an optional face string with options < Main | Base | Top | MinimumSide | MaximumSide > or an integer in the range [1, 5], with 1=Main, 2=Base, etc. |
-closest | This optional flag results in calculating the XYZ value of the point on the shape closest to the specified value. value is a point, or grid coord. |
value | This parameter is the value at which to get the XYZ value. Its interpretation is determined by the above flags. The default mode is the -parameter flag. |
This action returns an XYZ vector.
$shape getNormal ?< -parameter | -closest >? value
This action gets the normal of the surface in model space at the given parameter.
-parameter | This optional flag indicates to get the normal at a parameter. The value is a uv vector in the range [0.0, 1.0] followed by an optional face string with options < Main | Base | Top | MinimumSide | MaximumSide > or an integer in the range [1, 5], with 1=Main, 2=Base, etc. |
-closest | This optional flag results in calculating the normal of the point on the shape closest to the specified value. value is a point, or grid coord. |
value | This parameter is the value at which to get the normal. Its interpretation is determined by the above flags. The default mode is the -parameter flag. |
This action returns an XYZ vector.
$shape setSectionQuadrants quadrants
This action sets the section minimum and maximum angles of the shape to either 1, 2, 3 or 4 quadrants. This is just a shortcut for setting the minimum and maximum attributes to (0, 90) for 1 quadrant, (0, 180) for 2 quadrants, (0, 270) for 3 quadrants and (0, 360) for 4 quadrants.
quadrants | This parameter specifies the integer number of quadrants with valid values being 1, 2, 3, or 4. |
This action returns nothing.
$shape sphere ?-radius value? ?-baseAngle value? ?-topAngle value?
This action sets the shape to a sphere.
-radius value | This optional parameter is the float radius of the sphere with the range (0, infinity). The default is 1. |
-baseAngle value | This optional parameter specifies the float angle in degrees between the radial in the negative z axis direction and a radial line through the perimeter of the base. The angle should be in the range [0, 180). The default is 0. |
-topAngle value | This optional parameter specifies the float angle in degrees between the radial in the negative z axis direction and a radial line through the perimeter of the top. The angle should be in the range (0, 180]. The default is 180. |
This action returns nothing.
$shape cylinder ?-radius value? ?-topRadius value? ?-length value?
This action sets the shape to a cylinder, cone or disk. A disk is specified by setting the length to 0.
-radius value | This optional parameter is the float radius of the cylinder with the range [0, infinity). The default is 1, unless the -topRadius parameter is used, in which case the default is 0. |
-topRadius value | This optional parameter is the float radius of the top of the cylinder with the range [0, infinity). When used, the -radius parameter will specify the radius of the base only. |
-length value | This optional parameter is the float length of the cone with the range [0, infinity). The default is 1. |
This action returns nothing.
$shape box ?-width value? ?-topWidth value? ?-height value? ?-topHeight value? ?-length value?
This action sets the shape to a box, frustum or rectangle. A rectangle is specified by setting the length to 0.
-width value | This optional parameter is the float width of the box with the range [0, infinity). The default is 1, unless the -topWidth parameter is used, in which case the default is 0. |
-topWidth value | This optional parameter is the float width of the top of the box with the range [0, infinity). When used, the -width parameter will specify the width of the base only. |
-height value | This optional parameter is the float height of the box with the range [0, infinity). The default is 1, unless the -topHeight parameter is used, in which case the default is 0. |
-topHeight value | This optional parameter is the float height of the top of the box with the range [0, infinity). When used, the -height parameter will specify the height of the base only. |
-length value | This optional parameter is the float length of the box with the range [0, infinity). The default is 1. |
This action returns nothing.
$shape polygon -points vectors ?-slope type? ?-length value?
This action sets the shape to a polygon.
-points vectors | This parameter is a list of vectors of XYZ control points for the profile curve of the polygon. The length of the list must be greater than one. |
-slope type | This optional parameter is the string type method for calculating the slope vector for the control points of the profile curve of the polygon. Valid values are < Linear | Akima | CatmullRom | Bezier >, with the default being Linear. |
-length value | This optional parameter is the float length of the polygon with the range [0, infinity). The default is 1. |
This action returns nothing.
If the slope type is Bezier, the control points list should include the incoming and outgoing slope points and if the incorrect number of control and slope points are given, an error will be returned.
$shape getLength
This action gets the length parameter used to set the shape. If the current shape primitive does not use a length parameter, an error will be returned.
This action takes no parameters.
This action returns the float length.
$shape getBaseAngle
This action gets the base angle parameter used to set the shape. If the current shape primitive does not use a base angle parameter, an error will be returned.
This action takes no parameters.
This action returns the float base angle.
$shape getTopAngle
This action gets the top angle parameter used to set the shape. If the current shape primitive does not use a top angle parameter, an error will be returned.
This action takes no parameters.
This action returns the float top angle.
$shape getRadius
This action gets the radius parameter used to set the shape. If the current shape primitive does not use a radius parameter, an error will be returned.
This action takes no parameters.
This action returns the float radius.
$shape getTopRadius
This action gets the top radius parameter used to set the shape. If the current shape primitive does not use a radius parameter, an error will be returned.
This action takes no parameters.
This action returns the float top radius.
$shape getWidth
This action gets the width parameter used to set the shape. If the current shape primitive does not use a width parameter, an error will be returned.
This action takes no parameters.
This action returns the float width.
$shape getTopWidth
This action gets the top width parameter used to set the shape. If the current shape primitive does not use a width parameter, an error will be returned.
This action takes no parameters.
This action returns the float top width.
$shape getHeight
This action gets the height parameter used to set the shape. If the current shape primitive does not use a height parameter, an error will be returned.
This action takes no parameters.
This action returns the float height.
$shape getTopHeight
This action gets the top height parameter used to set the shape. If the current shape primitive does not use a top height parameter, an error will be returned.
This action takes no parameters.
This action returns the float top height.
$shape getPoints
This action gets the points parameter used to set the shape. If the current shape primitive does not use a points parameter, an error will be returned.
This action takes no parameters.
This action returns a list of vector XYZ control points.
$shape getSizeFieldSpacing
This action gets the minimum, average and maximum spacing of the size field associated with this shape.
This action takes no parameters.
This action returns a list of three floats representing the minimum, average and maximum spacing of the size field.
$shape getEnclosingEntities
This action gets the enclosing entities associated with this shape.
This action takes no parameters.
This action returns a list of pw::Entity objects that this shape enclosed during creation.
$shape setEnclosingEntities enclosingEnts
This action sets the enclosing entities associated with this grid shape.
enclosingEnts | This parameter is a list of pw::Entity objects that this grid shape encloses. |
This action returns nothing.
$shape getEnclosingEntitiesSpacing
This action gets the minimum, average and maximum spacing of the enclosing entities associated with this shape.
This action takes no parameters.
This action returns a list of three floats representing the minimum, average and maximum spacing of the enclosing entities.
$shape getExcludedSources
This action gets all source entities that are being explicitly excluded from affecting the grid generated by this shape
none
This action returns a list of pw::SourceEntity objects.
$shape excludeSource source ?exclude?
This action explicitly excludes a source from affecting the grid generated by this shape
source | This parameter is an pw::SourceEntity object to exclude |
exclude | This optional boolean parameter determines whether the entity should be added or removed from the excluded entities. The default value is true. |
nothing
$shape getIncludedSizeFieldEntities ?-global?
This action gets all entities that are being explicitly included in the size field that affects the grid generated by this shape
-global | this flag indicates that the returned list include all entities. If this flag is not set, only entities from the active framework are returned. |
This action returns a list of pw::Entity objects or a list of pw::Framework and pw::Entity objects.
$shape includeSizeFieldEntity entity ?include?
This action explicitly includes an entity in the size field source that affects the grid generated by this shape
entity | This parameter is an pw::Entity object to include in the size field, or a list including the framework path and the pw::Entity |
include | This optional boolean parameter determines whether the entity should be added or removed from the included entities. The default value is true. |
nothing
$shape getIncludedSizeFieldEntitiesSpacing
This action gets the minimum, average and maximum spacing of the explicitly included size field entities of this shape.
This action takes no parameters.
This action returns a list of three floats representing the minimum, average and maximum spacing of the explicitly included size field entities.
$shape delete
This action deletes the grid shape. This is necessary if the grid shape has not had updateGridEntities called on it, or if after calling updateGridEntities, the clearGridEntities action is called. Calling delete on a shape after it has had grid entities updated will\ generate an error.
none
This action does not return anything.
$shape updateGridEntities ?updateBlockAttributes? ?-boundaryAdaptation?
This action creates or updates the grid entities associated with this grid shape. If this action returns grid entities, then the shape can no longer be deleted by calling the GridShape.delete action, unless clearGridEntities is called first.
-updateBlockAttributes | This optional parameter specifies that the blocks being updated will also have the block’s attributes updated to match the current value of the grid shape’s attributes. This will always be the case with newly created blocks. |
-boundaryAdaptation | This optional parameter specifies that the blocks being created or update should have boundary adaptation performed on their domains as well. The default behavior is to simply initialize the domains. |
This action returns a list of pw::GridEntity objects.
$shape clearGridEntities
This action deletes the grid entities associated with this grid shape. After this point, the shape must be deleted by calling the GridShape.delete action, unless updateGridEntities is called.
This action takes no parameters.
This action does not return anything.
$shape getGridEntities ?-type type_string?
This action gets the grid entities currently associated with this grid shape.
-type type_string | This optional parameter filters the result to include only entities of the specified type. Only types derived from pw::GridEntity are valid. |
This action returns a list of pw::GridEntity objects.
$shape getBoundaryGridEntitiesSpacing ?-estimate?
This action gets the minimum, average and maximum spacing of the boundary grid entities associated with this shape.
-estimate | This optional parameter specifies that the spacing should be estimated based on the current parameters rather than the actual values of the current boundary grid entities. |
This action returns a list of three floats representing the minimum, average and maximum spacing of the boundary grid entities.
$shape getIncludedEntitiesInBlock ?type?
This action returns a list of pw::GridEntity objects that will be included in the block when the <IndcludeEntitiesInBlock> attribute is set to true.
type | This optional string parameter with options < All | Domains | Connectors | SymmetryConnectors | LaminaConnectors > specifies which entities to return. The default is All. |
This action returns a list of the pw::GridEntity objects.
$shape getBlockRegisters ?type?
This action gets the registers of the grid entities currently associated with this grid shape.
type | This optional string parameter with options < All | Symmetry | Enclosed | Other > specify which registers to return. Symmetry refers to the registers at the Minimum and Maximum sides of the shape. Enclosed refers to the registers associated with any of the enclosing entities. Other refers to the registers that are not associated with Symmetry and Enclosed registers. The default is All. |
This action returns a list of the registers of the grid entities generated by this shape with a block being the main entity.
$shape getAutomaticBackgroundSpacing
This action gets the calculated boundary spacing that is used when the <BackgroundSpacing> attribute is set to 0.0. The value is determined using the current extents of the shape, the extents of the shape’s enclosing entities, the <BoundaryDecay> attribute, and the GridBoundary attribute.
This action has no parameters.
This action returns the calculated boundary spacing as a float.
$shape getVoxelMinimumSize
This action gets the calculated voxel minimum size for a newly created voxel block from this grid shape.
This action has no parameters.
This action returns the voxel minimum size as a float.
$shape getVoxelMaximumSize
This action gets the calculated voxel maximum size for a newly created voxel block from this grid shape.
This action has no parameters.
This action returns the voxel maximum size as a float.
This action creates a new grid shape object.
pw::GridShape create
This action returns the entities that would be used in a block when a grid shape has IncludeEnclosingEntitiesInBlock set to true and the given entities are the enclosing entities.
pw::GridShape getEntitiesInBlock enclosingEnts
This attribute is the geometric transform of the shape.
$shape get/setTransform value
This attribute is the location of the transform pivot on the shape.
$shape get/setPivot pivot
This attribute is the sectional minimum angle in degrees of the shape, for shapes that support a sectional representation.
$shape get/setSectionMinimum angle
This attribute is the sectional maximum angle in degrees of the shape, for shapes that support a sectional representation.
$shape get/setSectionMaximum angle
This attribute is the type of cap used at the base of the shape.
$shape get/setBaseType type
This attribute is the type of cap used at the top of the shape.
$shape get/setTopType type
This attribute is the type of cap used at the sides of the shape when it is a partial shape (e.g.
$shape get/setSidesType type
This attribute is the type of grid that is generated from the shape.
$shape get/setGridType type
This attribute is the boundary mode that determines the dimension and distribution of connectors and domains that are generated from the shape.
$shape get/setGridBoundary mode
This attribute is a flag that controls whether the influence of sources should be ignored when a size field is generated for this entity.
$shape get/setIgnoreAllSources ignore
This attribute is a flag that controls whether the influence of explicitly included entities should be ignored when a size field is generated for this entity.
$shape get/setIgnoreAllSizeFieldEntities ignore
This attribute is the size field decay factor used as the decay when a size field is generated for this entity.
$shape get/setSizeFieldDecay decay
This attribute is the size background spacing when a size field is generated for this entity.
$shape get/setSizeFieldBackgroundSpacing spacing
This attribute is a string that controls how spacing is calculated for size field point primitives.
$shape get/setSizeFieldCalculationMethod method
This attribute controls whether the boundary of the entity should be ignored when the size field is generated for this entity.
$shape get/setSizeFieldIgnoreEntityBoundary ignore
This attribute controls whether the block generated from this shape should use the enclosing entities in the block’s face definition.
$shape get/setIncludeEnclosingEntitiesInBlock include
This attribute is the tolerance to use when determining which connectors of the enclosed domains should be included in the symmetry plane domains constructed by this grid shape.
$shape get/setSymmetryPlaneTolerance tol
This action checks if this shape is defined.
$shape isDefined
This action checks if this shape is solid
$shape isSolid
This action returns whether the given face is valid for the current configuration of the shape.
$shape isFaceValid face
This action gets the position in the defining space of the shape at the given parameter.
$shape getPosition ?< -parameter | -closest >? value
This action gets the position of the surface in model space at the given parameter.
$shape getXYZ ?< -parameter | -closest >? value
This action gets the center of the shape in model space.
$shape getCenterXYZ
This action gets the base of the shape in model space.
$shape getBaseXYZ
This action gets the top of the shape in model space.
$shape getTopXYZ
This action gets the position of the surface in object space at the given parameter.
$shape getObjectXYZ ?< -parameter | -closest >? value
This action gets the normal of the surface in model space at the given parameter.
$shape getNormal ?< -parameter | -closest >? value
This action sets the section minimum and maximum angles of the shape to either 1, 2, 3 or 4 quadrants.
$shape setSectionQuadrants quadrants
This action modifies the transform so that the minimum scale factor is set to one, and at the same time update the dimensions so the shape of the object remains unchanged.
$shape normalizeTransform
This action clears the shape.
$shape clear
This action sets the shape to a sphere.
$shape sphere ?-radius value? ?-baseAngle value? ?-topAngle value?
This action sets the shape to a cylinder, cone or disk.
$shape cylinder ?-radius value? ?-topRadius value? ?-length value?
This action sets the shape to a box, frustum or rectangle.
$shape box ?-width value? ?-topWidth value? ?-height value? ?-topHeight value? ?-length value?
This action sets the shape to a polygon.
$shape polygon -points vectors ?-slope type? ?-length value?
This action gets the current primitive type string of this shape with values being < None | Sphere | Cylinder | Box | Polygon >
$shape getPrimitive
This action gets the length parameter used to set the shape.
$shape getLength
This action gets the base angle parameter used to set the shape.
$shape getBaseAngle
This action gets the top angle parameter used to set the shape.
$shape getTopAngle
This action gets the radius parameter used to set the shape.
$shape getRadius
This action gets the top radius parameter used to set the shape.
$shape getTopRadius
This action gets the width parameter used to set the shape.
$shape getWidth
This action gets the top width parameter used to set the shape.
$shape getTopWidth
This action gets the height parameter used to set the shape.
$shape getHeight
This action gets the top height parameter used to set the shape.
$shape getTopHeight
This action gets the points parameter used to set the shape.
$shape getPoints
This action gets the slope type string used for creating the shape.
$shape getSlope
This action gets the minimum, average and maximum spacing of the size field associated with this shape.
$shape getSizeFieldSpacing
This action gets the enclosing entities associated with this shape.
$shape getEnclosingEntities
This action sets the enclosing entities associated with this grid shape.
$shape setEnclosingEntities enclosingEnts
This action gets the minimum, average and maximum spacing of the enclosing entities associated with this shape.
$shape getEnclosingEntitiesSpacing
This action gets all source entities that are being explicitly excluded from affecting the grid generated by this shape
$shape getExcludedSources
This action explicitly excludes a source from affecting the grid generated by this shape
$shape excludeSource source ?exclude?
This action gets all entities that are being explicitly included in the size field that affects the grid generated by this shape
$shape getIncludedSizeFieldEntities ?-global?
This action explicitly includes an entity in the size field source that affects the grid generated by this shape
$shape includeSizeFieldEntity entity ?include?
This action clears all explicitly included entities in the size field source from affecting the grid generated by this shape
$shape clearSizeFieldEntities
This action gets the minimum, average and maximum spacing of the explicitly included size field entities of this shape.
$shape getIncludedSizeFieldEntitiesSpacing
This action deletes the grid shape.
$shape delete
This action creates or updates the grid entities associated with this grid shape.
$shape updateGridEntities ?updateBlockAttributes? ?-boundaryAdaptation?
This action deletes the grid entities associated with this grid shape.
$shape clearGridEntities
This action gets the grid entities currently associated with this grid shape.
$shape getGridEntities ?-type type_string?
This action gets the minimum, average and maximum spacing of the boundary grid entities associated with this shape.
$shape getBoundaryGridEntitiesSpacing ?-estimate?
This action returns a list of pw::GridEntity objects that will be included in the block when the IndcludeEntitiesInBlock attribute is set to true.
$shape getIncludedEntitiesInBlock ?type?
This action gets the registers of the grid entities currently associated with this grid shape.
$shape getBlockRegisters ?type?
This action gets the calculated boundary spacing that is used when the BackgroundSpacing attribute is set to 0.0.
$shape getAutomaticBackgroundSpacing
This action gets the calculated voxel minimum size for a newly created voxel block from this grid shape.
$shape getVoxelMinimumSize
This action gets the calculated voxel maximum size for a newly created voxel block from this grid shape.
$shape getVoxelMaximumSize
This attribute is the connector tolerance of grid entities and operations.
pw::Grid get/setConnectorTolerance tolerance