pw:: Dimensioner

The connector dimensioning mode type

Derives From

pw::Object pw::Mode

Summary
The connector dimensioning mode type
This action checks if the dimensions are currently balanced.
This action checks if the dimensions can be reset to a previous balanced state.
This action sets the dimensions back to the last balanced state.
This action tries to balance the current dimensions.
This action gets the number of connector dimensioning groups.
This action gets the connectors of a dimensioning group using the group index or a connector.
This action gets a list of the connectors that are unbalanced.
This action gets a list of the domains that are unbalanced.
This action gets a list of the connectors that are affected by the dimensioning.
This action gets a list of the domains that are affected by the dimensioning.

Instance Actions

isBalanced

$dim isBalanced

This action checks if the dimensions are currently balanced.

Parameters

This action has no parameters.

Returns

This action returns a boolean, true if dimensions are balanced.

canReset

$dim canReset

This action checks if the dimensions can be reset to a previous balanced state.

Parameters

This action has no parameters.

Returns

This action returns a boolean, true if dimensions can be reset.

reset

$dim reset

This action sets the dimensions back to the last balanced state.

Parameters

This action has no parameters.

Returns

This action returns nothing.

balance

$dim balance ?-resetGeneralDistributions?

This action tries to balance the current dimensions.

Parameters

-resetGeneralDistributionsThis optional flag, if present, will clear any general distribution functions on the connectors that are redimensioned as a result of the balancing operation.

Returns

This action returns nothing.

Information

This command sets the dimension of all of the connectors in a group equal to the dimension of the most recently modified connector, and then balances domains by adjusting the dimensions of connectors.

getGroupCount

$dim getGroupCount

This action gets the number of connector dimensioning groups.

Parameters

This action has no parameters.

Returns

This action returns the integer number of gropus.

getGroup

$dim getGroup < index | con >

This action gets the connectors of a dimensioning group using the group index or a connector.

Parameters

indexThis parameter is the integer group to get the connectors.
conThis parameter is the connectors of the group that this pw::Connector is in.

Returns

This action returns a list of pw::Connector objects.

getUnbalancedConnectors

$dim getUnbalancedConnectors ?-initial? ?-modified? ?-balanced?

This action gets a list of the connectors that are unbalanced.

Parameters

-initialThis optional flag is the notification to get unbalanced connectors with dimensions the same as the initial or last balanced system.
-modifiedThis optional flag is the notification to get unbalanced connectors with dimensions that have been explicitly modified.
-balancedThis optional flag is the notification to get unbalanced connectors with dimensions that have been modified by use of the balance command.

Returns

This action returns a list of pw::Connector objects.

getUnbalancedDomains

$dim getUnbalancedDomains

This action gets a list of the domains that are unbalanced.

Parameters

This action has no parameters.

Returns

This action returns a list of pw::Domain objects.

getAffectedConnectors

$dim getAffectedConnectors

This action gets a list of the connectors that are affected by the dimensioning.

Parameters

This action has no parameters.

Returns

This action returns a list of pw::Connector objects.

getAffectedDomains

$dim getAffectedDomains

This action gets a list of the domains that are affected by the dimensioning.

Parameters

This action has no parameters.

Returns

This action returns a list of pw::Domain objects.

$dim isBalanced
This action checks if the dimensions are currently balanced.
$dim canReset
This action checks if the dimensions can be reset to a previous balanced state.
$dim reset
This action sets the dimensions back to the last balanced state.
$dim balance ?-resetGeneralDistributions?
This action tries to balance the current dimensions.
$dim getGroupCount
This action gets the number of connector dimensioning groups.
$dim getGroup < index | con >
This action gets the connectors of a dimensioning group using the group index or a connector.
$dim getUnbalancedConnectors ?-initial? ?-modified? ?-balanced?
This action gets a list of the connectors that are unbalanced.
$dim getUnbalancedDomains
This action gets a list of the domains that are unbalanced.
$dim getAffectedConnectors
This action gets a list of the connectors that are affected by the dimensioning.
$dim getAffectedDomains
This action gets a list of the domains that are affected by the dimensioning.
Base type for all glyph types
The mode base type
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.
An integer is a whole number.
Connector type
Domain type