pw::Spacing

Base class for spacing types

Derives From

pw::Object

Summary
pw::SpacingBase class for spacing types
Static Actions
createNamedValueThis action defines a named spacing value.
getNamedValueNamesThis action returns a list of named spacing values.
getNamedValueThis action returns value of a named spacing value.
changeNamedValueThis action changes the value of a named spacing value.
renameNamedValueThis action renames a named spacing value.
deleteNamedValueThis action deletes a named spacing value.
Instance Actions
deleteThis action deletes the spacing.
getNameThis action returns the name of the spacing if it is a named spacing value.

Static Actions

createNamedValue

pw::Spacing createNamedValue ?name ?value??

This action defines a named spacing value.

Parameters

nameThe optional name to assign the spacing value.  The name may be altered if the name duplicates another named spacing value.  The name should not be an empty string, a string that could be interpreted as a float value, or a string that starts with the Pointwise namespace qualifier “::pw”.
valueThis optional argument defines the initial value.  It should be a float value greater than or equal to 0.  The default value is 0.

Returns

This function returns a string result representing the name of the newly created named spacing value.  It may be different from the name passed in as the optional first argument.

getNamedValueNames

pw::Spacing getNamedValueNames

This action returns a list of named spacing values.

Parameters

This function takes no parameters.

Returns

This command returns a list of the names of the named spacing values.  Each entry in the list is a string value.

getNamedValue

pw::Spacing getNamedValue name

This action returns value of a named spacing value.

Parameters

nameThis argument is the name of the named spacing value to query.

Returns

This command returns the float value of the named spacing value.

changeNamedValue

pw::Spacing changeNamedValue name value

This action changes the value of a named spacing value.

Parameters

nameThis argument is the name of the named spacing value to change.
valueThis parameter is the new float value to assign to the named spacing value.  The value should be a non-negative number.

Returns

This command returns nothing.

renameNamedValue

pw::Spacing renameNamedValue oldname newname

This action renames a named spacing value.

Parameters

oldnameThis argument is the name of the named spacing value to change.
newnameThis parameter is the new string name for the named spacing value.  The name may be modified to avoid conflicts.  The name should not be an empty string, a string that could be interpreted as a float value, or a string that starts with the Pointwise namespace qualifier “::pw”.

Returns

This command returns the new name of the named spacing value as a string.  It may be a modified form of the newname value if there was a naming conflict.

deleteNamedValue

pw::Spacing deleteNamedValue name

This action deletes a named spacing value.  Any distributions with the named spacing will retain their current spacing.

Parameters

nameThis argument is the name of the named spacing value to delete.

Returns

This command returns nothing.

Instance Actions

delete

$spacing delete

This action deletes the spacing.  This is necessary if the spacing has not been added to a pw::Distribution.  Calling delete on a spacing after it has been added, will generate an error.

Parameters

none

Returns

This action returns nothing.

getName

$spacing getName

This action returns the name of the spacing if it is a named spacing value.  It returns an empty string otherwise.

Parameters

none

Returns

If the spacing object is a named spacing value, the return value will be a string representing the name.  Otherwise, an empty string is returned.

pw::Spacing createNamedValue ?name ?value??
This action defines a named spacing value.
pw::Spacing getNamedValueNames
This action returns a list of named spacing values.
pw::Spacing getNamedValue name
This action returns value of a named spacing value.
pw::Spacing changeNamedValue name value
This action changes the value of a named spacing value.
pw::Spacing renameNamedValue oldname newname
This action renames a named spacing value.
pw::Spacing deleteNamedValue name
This action deletes a named spacing value.
$spacing delete
This action deletes the spacing.
$spacing getName
This action returns the name of the spacing if it is a named spacing value.
Base type for all glyph types
A float is a fractional number.
A string is an array of characters.
Base class for distribution types
Close