Base class for distribution types
pw:: | Base class for distribution types |
Instance Attributes | |
Variable | This attribute is the grid point distribution variable. |
Normal | This attribute is the grid point distribution normal. |
Instance Actions | |
delete | This action deletes the distribution. |
getBeginSpacing | This action gets the requested grid point spacing at the beginning of the distribution. |
setBeginSpacing | This action sets the requested grid point spacing at the beginning of the distribution. |
getEndSpacing | This action gets the requested grid point spacing at the end of the distribution. |
setEndSpacing | This action sets the requested grid point spacing at the end of the distribution. |
reverse | This action reverses the distribution, including the spacing constraints. |
copy | This action creates a copy of the distribution. |
$dist get/setVariable < ArcLength | X | Y | Z >
This attribute is the grid point distribution variable.
This attribute is a string with options < ArcLength | X | Y | Z | NonAligned >.
The default for this attribute is ArcLength.
This attribute is related to the Normal attribute. Setting this attribute will change the Normal attribute to match the value of this attribute.
NonAligned is not a valid value for setVariable. NonAligned is only returned when a non-axis aligned, normal vector has been assigned to Normal.
$dist get/setNormal vector
This attribute is the grid point distribution normal.
This attribute is an xyz vector.
The default for this attribute is “0 0 0”.
This attribute is related to the Variable attribute. Setting this attribute will change the Variable attribute to match the value of this attribute.
If the value of this attribute is the zero vector, the Variable will be set to ArcLength.
$dist delete
This action deletes the distribution.
This action has no parameters.
This action returns nothing.
This is necessary to delete a distribution that has not been added to a pw::Connector.
Calling delete on a distribution after it has been added to a pw::Connector, will generate an error.
$dist getBeginSpacing
This action gets the requested grid point spacing at the beginning of the distribution.
This action has no parameters.
This action returns a pw::Spacing object.
$dist setBeginSpacing < -clearname | spacing | value | name >
This action sets the requested grid point spacing at the beginning of the distribution.
-clearname | This parameter allows the spacing to be disassociated from any named spacing value. The current spacing will be unaffected. |
spacing | This parameter is a pw::Spacing object. |
value | This parameter is the float value to set for a pw::SpacingExplicit object which will be created for the begin spacing of this distribution with the range [0, infinity). |
name | This parameter is a string value corresponding to a named spacing value created with <pw::Spacing.createNamedValued>. This spacing will continue to be associated with the named spacing value until it is reset with the -clearname argument or overridden with a new named spacing value. |
This action returns nothing.
$dist getEndSpacing
This action gets the requested grid point spacing at the end of the distribution.
This action has no parameters.
This action returns a pw::Spacing object.
$dist setEndSpacing < -clearname | spacing | value | name >
This action sets the requested grid point spacing at the end of the distribution.
-clearname | This parameter allows the spacing to be disassociated from any named spacing value. The current spacing will be unaffected. |
spacing | This parameter is a pw::Spacing object. |
value | This parameter is the float value to set for a pw::SpacingExplicit object which will be created for the end spacing of this distribution with the range [0, infinity). |
name | This parameter is a string value corresponding to a named spacing value created with <pw::Spacing.createNamedValued>. This spacing will continue to be associated with the named spacing value until it is reset with the -clearname argument or overridden with a new named spacing value. |
This action returns nothing.
This attribute is the grid point distribution variable.
$dist get/setVariable < ArcLength | X | Y | Z >
This attribute is the grid point distribution normal.
$dist get/setNormal vector
This action deletes the distribution.
$dist delete
This action gets the requested grid point spacing at the beginning of the distribution.
$dist getBeginSpacing
This action sets the requested grid point spacing at the beginning of the distribution.
$dist setBeginSpacing < -clearname | spacing | value | name >
This action gets the requested grid point spacing at the end of the distribution.
$dist getEndSpacing
This action sets the requested grid point spacing at the end of the distribution.
$dist setEndSpacing < -clearname | spacing | value | name >
This action reverses the distribution, including the spacing constraints.
$dist reverse
This action creates a copy of the distribution.
$dist copy