pw:: Connector

A connector is a computationally one-dimensional grid entity, defined in the parameter space of one or more end-connected curve segments.

Derives From

pw::Object pw::Entity pw::GridEntity

Summary

pw:: Connector	A connector is a computationally one-dimensional grid entity, defined in the parameter space of one or more end-connected curve segments.
Static Actions
create	This action creates a new connector object.
createOnDatabase	This action creates new connector objects on the given database entities.
createFromPoints	This action, given a list of XYZ vector values or database-constrained points, creates a new connector.
join (static)	This action joins as many of the given connectors together as possible.
getBestSegment	This action, given two point-lists, returns a segment type, a start point, an end point, and a ProjectToCommon state that represent the best segment for a connector between the given points.
getConnectorsFromNode	This action gets a list of all connectors using the specified node.
getConnectorsFromSpacing	This action gets a list of all connectors using the specified spacing object.
getAdjacentConnectors	This action finds the connectors adjacent to the given list of connectors.
getConnectorsInPlane	This action looks for connectors in a plane, with the candidate connectors given explicitly or implicitly from the given entities.
doConnectorsGetDimension	This action checks if connectors will have a dimension after being created and the calculateDimension method called on them, based on the current settings.
getInvalidDistributions	This action finds connectors that have invalid distributions.
setDimensionFromSizeField	This action modifies the distribution and dimension of a list of pw::Connector objects based on the current size field.
synchronizeSpacings	This action synchronizes spacing constraints at shared connector grid points.
applyTRex (static)	This action will create (if not specified) and apply T-Rex boundary conditions to the unstructured domains that use the given connectors.
swapDistribution	This action replaces the distribution function of a list of subconnectors, retaining the previously set spacings.
Static Defaults
Dimension (Default)	This default is the dimension of a connector when it is created.
DistributionType (Default)	This default is the distribution of a subconnector when it is created.
BeginSpacing (Default)	This default is the beginning spacing of a subconnector when it is created.
EndSpacing (Default)	This default is the ending spacing of a subconnector when it is created.
Static Attributes
CalculateDimensionMethod	This attribute is the dimension of a connector when it is created implicitly or when the calculateDimension action is called.
CalculateDimensionMaximum	This attribute is the maximum dimension calculated for a connector when using the commands calculateDimension, setDimensionFromSpacing, and setDimensionFromDistribution.
CalculateDimensionSpacing	This attribute is the default average spacing between successive grid points.
DistributionInfluence	This default is a flag to allow the distribution of a connector to effect the dimension of the connector.
NormalMaximumDeviation	This default is the maximum turning angle allowed between successive grid points.
CurveMaximumDeviation	This attribute is the maximum distance allowed between the analytic and discrete shape of a connector.
SurfaceCurvatureInfluence	This default is a flag that allows the underlying surface of a connector to affect the NormalMaximumDeviation and CurveMaximumDeviation constraints.
Instance Actions
delete	This action delete this connector.
calculateDimension	This action sets the dimension of this connector using its current solver settings.
getDimension	This action gets the dimensions of this connector.
getDimensions	This action gets the dimensions of this connector.
setDimension	This action sets the dimension of this connector.
setDimensionFromSpacing	This action sets the dimension of this connector based on equal spacing.
setDimensionFromDistribution	This action sets the dimension of this connector based on the current distribution.
setSubConnectorDimensionFromDistribution	This action sets the dimension of a subconnector in this connector based on the current distribution of the subconnector.
setDimensionFromSubConnectors	This action sets the dimension of this connector by copying the dimension from a list of subconnectors.
increaseDimension	This action increases the dimension of this connector.
getSegmentCount	This action gets the number of segments in this connector.
getSegment	This action gets the segment at the given index.
getSegments	This action gets the list of segments.
setSegment	This action sets the segment at the given index.
addSegment	This action adds the segment to the end of the segments in the connector.
insertSegment	This action inserts the segment at the given index.
removeSegment	This action removes a segment from the connector.
removeAllSegments	This action removes all of the segments from the connector.
replaceAllSegments	This action replaces all of the segments in the connector.
getSubConnectorCount	This action gets the number of subconnectors in this connector.
getSubConnectorDimension	This action gets the dimension of a subconnector in this connector.
setSubConnectorDimension	This action sets the dimensions of each subconnector in this connector.
getSubConnectorRange	This action gets the minimum and maximum grid point indices of a subconnector.
getSubConnectorRanges	This action gets the minimum and maximum grid point indices of all subconnectors.
getDistribution	This action gets the distribution function of a subconnector.
setDistribution	This action sets the distribution function of a subconnector.
replaceDistribution	This action replaces the distribution function of a subconnector, retaining the previously set spacings.
lockDistribution	This action locks the distribution of a subconnector.
resetGeneralDistributions	This action switches all of the subconnector distributions that are of type pw::DistributionGeneral to use the current default distribution.
getBreakPoint	This action gets the parameter of the break point at the end of the subconnector with the given index.
getBreakPoints	This action gets the parameters of the break points at the end of the subconnectors.
getBreakPointType	This action gets the type of break point at the end of the subconnector.
getBreakPointTypes	This action gets the type at each break point at the end of the subconnectors.
addBreakPoint	This action adds one or more break points to the list of break points.
removeBreakPoint	This action removes the break point from the connector at the end of the subconnector with the given index.
removeAllBreakPoints	This action removes all of the break points from the connector.
checkBreakPoint	This action checks if a break point can be added at a given location.
setBreakPointSpacing	This action sets the spacing on both sides of a break point.
spline	This action sets the shape of this connector to a smooth interpolation of the grid points of the given connector.
fitLSQ	This action sets the shape of this connector to a least squares fit approximation of the grid points of the given connector.
smoothC1	This action sets the shape of this connector to a C1 continuous approximation of the shape of the given connector.
split	This action splits this connector at the given index or point.
join	This action joins this connector with a given connector.
project	This action projects this connector onto one or more database entities.
getDefaultProjectDirection	This action gets the default projection direction for this connector.
setOrientation	This action sets the orientation of this connector, by specifying the new imin node.
alignOrientation	This action aligns the I orientation of the given connectors with this connector.
createPeriodic	This action creates a periodic copy of this connector.
getPeriodic	This action gets the connector that shares a periodic link with this connector.
breakPeriodic	This action breaks the periodic link that this connector has with another connector.
getPoint	This action gets the position of a connector grid point.
getPoints	This action gets all the connector grid points.
setPoint	This action sets the position of a connector interior grid point.
getPosition	This action gets a position on a connector in the defining space of the connector.
getXYZ	This action gets the model space position on a connector.
getParameter	This action gets a parameter value on a connector.
getRadiusOfCurvature	This action returns the radius of curvature at the specified position on the connector.
getTangent	This action gets the tangency vector on a connector.
getGeometricProperties	This action calculates the geometric properties at the specified position on the connector.
getTransverseAngle	This action gets the transverse angle, in degrees, at a position on a connector in the defining space of the connector, and optionally whether the connector is convex or concave at that position.
getLength	This action gets the connector length from the beginning to a given location.
getParameters	This action gets the parameters at which the curve intersects the value.
getTotalLength	This action gets the total length of the connector.
getAssembleTolerance	This action returns the maximum tolerance used to close the model along the connector.
getAverageSpacing	This action gets the average spacing between grid points of the connector.
closestPoint	This action gets the closest point on this connector to the given point.
closestControlPoint	This action gets the control point on this connector closest to the given point.
getControlPointCount	This action gets the number of control points on this connector.
removeInteriorControlPoints	This action removes the interior control points of each segment of this connector.
getNode	This action gets a node from a connector.
isClosed	This action checks if the connector is closed.
isPole	This action checks if the connector is a pole.
checkDistributionValidity	This action checks if the connector’s distributions on all of its subconnectors could be applied as requested.
isInteriorIndex	This action checks to see if an index corresponds to a point in the interior of the connector.
getAdjacentIndices	This action returns the indices that are directly connected to the specified index.
getCellCount	This action gets the number of 1D cells in this connector.
getCell	This action gets the indices of the given 1D cell.
getCells	This action gets the indices of all the 1D cells.
applyTRex	This action will create (if not specified) and apply a T-Rex boundary condition to the unstructured domains that use this connector.

pw::Connector setCalculateDimensionMethod Spacing
pw::Connector setCalculateDimensionSpacing 0.3
set conic(1) [pw::SegmentConic create]
$conic(1) addPoint {-25 8 0}
$conic(1) addPoint {-8 8 0}
$conic(1) setIntersectPoint {-20 20 0}
set conic(2) [pw::SegmentConic create]
$conic(2) addPoint [$conic(1) getPoint [$conic(1) getPointCount]]
$conic(2) addPoint {10 16 0}
$conic(2) setShoulderPoint {8 8 0}
set con(1) [pw::Connector create]
$con(1) addSegment $conic(1)
$con(1) addSegment $conic(2)
$con(1) calculateDimension
puts "[$con(1) getName] has dimension of [$con(1) getDimension]."

createOnDatabase

pw::Connector createOnDatabase ?-merge tolerance? ?-splitConnectors split_angle? ?-joinConnectors join_angle? ?-parametricConnectors mode? ?-reject rejectVar? ?-type type? entity_or_boundary_list

This action creates new connector objects on the given database entities.

Parameters

-merge tolerance	This optional parameter is the float tolerance for automatic connector merging in the range [0, infinity). The default is 0 (no merging).
-splitConnectors split_angle	This optional parameter is the float turning angle to split connectors at in the range [0, 180). The default is 0 (no splitting).
-joinConnectors join_angle	This optional parameter is the float turning angle to join connectors at in the range [0, 180). The default is 0 (no joining).
-parametricConnectors mode	This optional parameter is the string mode for how connectors are created on parametric surfaces with options < EndToEnd \| Aligned >. The default is EndToEnd.
-reject rejectVar	This optional parameter is the string name of a variable to receive a list of pw::DatabaseEntity objects that were rejected for placing connectors on. If a name is not given, rejections will be silently ignored.
-type type	This optional parameter is the string name of the type of grid with options < Structured \| Unstructured > to use when creating connectors from database entities. This defaults to structured construction if not explicitly set to Unstructured.
entity_or_boundary_list	This required parameter is a list of pw::DatabaseEntity objects and/or boundaries.

Returns

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

Information

This command supports progress updates.

Example

This example shows how to create connectors from database entities. The -joinConnectors parameter is used to join connectors with a turning angle of less than 60 degrees. The distribution of each connector created is then changed to Tanh.

Code

pw::Connector setDefault Dimension 15
set db [pw::Database getAll]
set cons [pw::Connector createOnDatabase -joinConnectors 60 $db]
foreach con $cons {
    $con replaceDistribution 1 [pw::DistributionTanh create]
}

package require PWI_Glyph 3.18.3
set idim 7
set origin {10 10 10}
set ivec {6 0 0}

set p000 $origin
set pts [list]
for {set i 1} {$i <= $idim} {incr i} {
set x [ expr { [lindex $p000 0] + $idim - [ expr {[lindex $ivec 0] * $i / $idim} ] } ]
set pt [pwu::Vector3 set $x 10 10]
lappend pts $pt
}

# Create connector using GgVec3
set con(1) [pw::Connector createFromPoints $pts]
puts "PointCount [$con(1) getPointCount]

join (static)

pw::Connector join ?<-keepDistribution | -resetDistribution>? ?-deleteBreakPoints? ?-reject rejectVar? connectors

This action joins as many of the given connectors together as possible.

Parameters

-keepDistribution	This optional flag is notification that break points will be inserted into the newly joined connector in order to maintain the grid point distributions of each connector being joined and all existing break points will also be preserved. However, if the deleteBreakPoints flag is also used, just the grid point distributions will be preserved, and all break points will be deleted. This flag cannot be used in conjunction with the -resetDistribution flag.
-resetDistribution	This optional flag is notification that all break points will be deleted, and the distribution function of the resulting connector will be reset to the current default distribution function. This flag cannot be used in conjunction with the -keepDistribution flag.
-deleteBreakPoints	This optional flag is notification to delete all break points even if the -keepDistribution flag is present. The grid point distributions of the individual connectors will be maintained unless the -resetDistribution flag is also used.
-reject rejectVar	This optional parameter is the string name of a variable to receive a list of pw::Connector objects that were not joined.
connectors	This required parameter is a list of pw::Connector objects to join.

Note

If none of the above flags is present, all break points will be removed from the connectors and their distribution functions will be set to the default.

Returns

This action returns a list of the pw::Connector objects that were joined.

Information

This command supports progress updates.

Example

This example shows how to join multiple connectors at once but keep the distribution settings by adding break points. The reject parameter is used to find which connectors were not joined. $con(1), $con(2) and $con(3) are referencing existing connectors.

Code

pw::Connector join -keepDistribution -reject rj \
    [list $con(1) $con(2) $con(3)]
foreach var $rj {
    puts [$var getName]
}

Output

con-3

getConnectorsFromSpacing

pw::Connector getConnectorsFromSpacing ?-details? ?-global? spacing

This action gets a list of all connectors using the specified spacing object.

Parameters

-details	This optional flag changes the return format. By default, the command returns a list of connectors. When this option is specified, the return value will be a list of connector/sub-connector/side triplets. The first value in each entry will be a pw::Connector. The second entry will be the integer index of sub-connector containing the spacing, and the third entry will be a string with options, < Begin \| End > indicating the side of the sub-connector containing the space. Note that in the case, if a connector uses a spacing more than once, it will be listed multiple times since the sub-connector index and side values will be different for each entry.
-global	This optional flag controls whether connectors from inactive frameworks are included in the result. By default, only connectors in the active framework are included in the return value. When this option is present, all connectors using the specified spacing object are included.
spacing	This required parameter is a pw::Spacing object or a named spacing value.

Returns

This action returns a list of pw::Connector objects by default. If the -details parameter is present, the return value will be a list of entries with three values each. Each entry will contain the pw::Connector, the sub-connector integer index, and the side (a string value with options < Begin | End >) to indicate exactly where the spacing was used. Regardless of the presence of the -details flag, only connectors in the active framework are returned unless the -global flag is used.

Example

This example shows how to get a list of all connectors using the given spacing. $con(1) is referencing an existing connector.

Code

set spacing [[$con(1) getDistribution 1] getBeginSpacing]
set cnctrs [pw::Connector getConnectorsFromSpacing \
    -details $spacing]
foreach $conSubSide $cnctrs {
    set cnctr [lindex $conSubSide 0]
    set sub [lindex $conSubSide 1]
    set side [lindex $conSubSide 2]
    puts "[$cnctr getName] sub-connector $sub $side"
}

Output

con-1 sub-connector 1 Begin
con-1 sub-connector 2 End
con-4 sub-connector 1 End
con-5 sub-connector 1 Begin

setDimensionFromSizeField

pw::Connector setDimensionFromSizeField ?-include ents? ?-exclude ents? ?-ignoreAll? ?-matchDimensions? ?-backgroundSpacing spacing? ?-defaultDecay decay? ?-calculationMethod method? connectors

This action modifies the distribution and dimension of a list of pw::Connector objects based on the current size field.

Parameters

-include ents	This optional parameter is a list of framework_entity objects to add to the size field. If not specified, no extra entities will be added to the size field, only the source entities whose extents overlap the given connectors.
-exclude ents	This optional parameter is a list of pw::SourceEntity objects to exclude from the automatically included in the size field.
-ignoreAll	This optional flag specifies that the size field should ignore all automatically included source entities from the size field.
-matchDimensions	This optional flag specifies that all connectors should have their dimensions set to the same number. By default, each connector is dimensioned separately from one another.
-backgroundSpacing spacing	This optional parameter is the float background spacing of the size field in the range (0, infinity). This is the spacing that will be used far away from any the entities in the size field. The default is 0, which specifies that the background spacing should be computed from the extents of the given connectors.
-defaultDecay decay	This optional parameter is the float decay in the range [0, 1] that will be used for any pw::GridEntity object specified by the -include parameter. If not specified, a decay of 0.5 will be used.
-calculationMethod method	This optional parameter is the string method that controls how spacing is calculated for size field point primitives with options < MinimumDistance \| InverseDistance \| BlendDistance \| MinimumValue >. If not specified, MinimumDistance will be used.
-refineOnly	This optional flag specifies that the current dimension and distribution should be used to limit coarsening of the connector spacing.
connectors	This required parameter is a list of pw::Connector objects to set the dimension and distribution based on the size field.

Returns

This action returns nothing.

applyTRex (static)

pw::Connector applyTRex ?-refine? ?<-wall bc1 | -angle bc1 | -aspectratio bc1 | -maxaspectratio bc1>? ?-adjacent bc2? ?-unused connectorVar? ?-domains domainVar? connectors

This action will create (if not specified) and apply T-Rex boundary conditions to the unstructured domains that use the given connectors. If a connector is shared with a structured domain, the AdjacentGrid bc will be applied to the unstructured domains that use that connector. If a boundary condition is not specified, the default T-Rex boundary condition Type along with the corresponding default value will be applied.

Parameters

-refine	This optional parameter specifies that the collection of unstructured domains that had the T-Rex bcs applied will be refined.
-wall bc1	This optional parameter specifies the Wall pw::TRexCondition to apply. Cannot be used simultaneously with -angle, -aspectratio or -maxaspectratio.
-angle bc1	This optional parameter specifies the Angle pw::TRexCondition to apply. Cannot be used simultaneously with -wall, -aspectratio or -maxaspectratio.
-aspectratio bc1	This optional parameter specifies the AspectRatio pw::TRexCondition to apply. Cannot be used simultaneously with -wall, -angle or -maxaspectratio.
-maxaspectratio bc1	This optional parameter specifies the MaximumAspectRatio pw::TRexCondition to apply. Cannot be used simultaneously with -wall, -angle or -aspectratio.
-adjacent bc2	This optional parameter specifies the AdjacentGrid pw::TRexCondition to apply.
-unused connectorVar	This optional parameter is the string name of the variable that receives a list of pw::Connector objects that were unused.
-domains domainsVar	This optional parameter is the string name of the variable that receives a list of pw::DomainUnstructured objects that the T-Rex bcs were applied to.
connectors	This required parameter is the list of pw::Connector objects for which T-Rex boundary conditions will be applied to associated pw::DomainUnstructured objects.

Information

This command supports progress updates.

Returns

List of T-Rex boundary conditions that have been created and assigned.

addBreakPoint

$con addBreakPoint ?< -control | -arc | -X | -Y | -Z | -U | -V >? value

This action adds one or more break points to the list of break points.

Parameters

-arc	This optional flag causes an Arc type break point to be added at an arc length. The value is the normalized, float arc length from the start of the connector in the range [0.0, 1.0]. This is the default option.
-control	This optional flag causes a Control type break point to be added at a control point. The value is an integer index with the range (1, number of control points).
-X	This optional flag causes an Arc type break point to be added at each occurrence of specified X location on the connector. A location will be skipped if another break point is already present in the vicinity. The value is a float X Cartesian coordinate.
-Y	This optional flag causes an Arc type break point to be added at each occurrence of specified Y location on the connector. A location will be skipped if another break point is already present in the vicinity. The value is a float Y Cartesian coordinate.
-Z	This optional flag causes an Arc type break point to be added at each occurrence of specified Z location on the connector. A location will be skipped if another break point is already present in the vicinity. The value is a float Z Cartesian coordinate.
-U	This optional flag causes an Arc type break point to be added at each occurrence of specified U location on the connector. A location will be skipped if another break point is already present in the vicinity. The value is a float in the range (0.0, 1.0).
-V	This optional flag causes an Arc type break point to be added at each occurrence of specified V location on the connector. A location will be skipped if another break point is already present in the vicinity. The value is a float in the range (0.0, 1.0).
value	This required parameter is the float or integer value to position the break point.

Information

Only one of -arc, -control, -X, -Y, -Z, -U or -V flags is allowed.

Returns

This action returns the integer index of the break point added. In the case of the -X, -Y, -Z, -U, or -V options, the return value is a list of the integer break point indices added.

Example

This example shows how to add a break point at three different X locations on a connector. $con(1) is referencing an existing connector.

Code

foreach bp [list -15 0 10] {
    puts [$con(1) addBreakPoint -X $bp]
}

Output

1
2
3

join

$con join ?<-keepDistribution | -resetDistribution>? ?-deleteBreakPoints? connector ?side?

This action joins this connector with a given connector.

Parameters

-keepDistribution	This optional flag is notification that break points will be inserted into the newly joined connector in order to maintain the grid point distributions of each connector being joined and all existing break points will also be preserved. However, if the deleteBreakPoints flag is also used, just the grid point distributions will be preserved, and all break points will be deleted. This flag cannot be used in conjunction with the -resetDistribution flag.
-resetDistribution	This optional flag is notification that all break points will be deleted, and the distribution function of the resulting connector will be reset to the current default distribution function. This flag cannot be used in conjunction with the -keepDistribution flag.
-deleteBreakPoints	This optional flag is notification to delete all break points even if the -keepDistribution flag is present. The grid point distributions of the individual connectors will be maintained unless the -resetDistribution flag is also used.
connector	This required parameter is the pw::Connector object to join.
side	This optional parameter is the side of this connector to join with options < Any \| Begin \| End >.

Note

If neither of the above flags is present, all break points will be removed from the given connector and its distribution function will be set to the default.

Returns

This action returns nothing.

Example

This example shows how to join two connectors but keep the distribution settings by adding a break point. $con(1) is referencing an existing connector.

Code

$con(1) join -keepDistribution $con(2)

project

$con project ?-type proj_type? ?-direction direction? ?-center center? ?-axis point normal? ?-fit tolerance? ?<-interior | -shape>? ?dbentities?

This action projects this connector onto one or more database entities.

Parameters

-type proj_type	This optional parameter is the string projection type to perform with options < ClosestPoint \| Linear \| SphericalIn \| SphericalOut \| CylindricalIn \| CylindricalOut >.
-direction direction	This optional parameter is the projection vector for linear projection. The default is determined by the entity and can be queried using getDefaultProjectDirection.
-center center	This optional parameter is the center point vector for spherical projection. The default is (0, 0, 0).
-axis point normal	This optional parameter is the axis defined by a point vector and normal vector used by cylindrical projection; The default point is (0, 0, 0) and the default normal is (1, 0, 0).
-fit tolerance	This is an optional parameter is the float tolerance used to fit any curve-like entities. The default for this is 0 which means there is no fitting applied onto the projected curve. The valid range for this parameter is [0.0,infinity)
-interior	If this optional flag is present, only the interior of the entities are projected. If this is specified, -shape cannot be specified.
-shape	If this optional flag is present, the shape of the underlying curve will be projected to the database and the original distribution will be reapplied after the projection. If this is specified, -interior cannot be specified.
dbentities	This optional parameter is a list of curve and surface-like pw::DatabaseEntity to project onto. If none are given, project to any currently enabled, visible database surface-like entities.

Returns

This action returns nothing.

Example

This example shows how to project a connector linearly along the -Y axis onto the first database entity it encounters in that path. $con(1) is referencing an existing connector.

Code

$con(1) project -type Linear -direction "0 -1 0"

getPosition

$con getPosition ?< -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest >? value

This action gets a position on a connector in the defining space of the connector.

Parameters

-grid	This optional flag is the notification to get the position at a grid point. value is an integer index [1, number of grid points]. This is the default option.
-control	This optional flag is the notification to get the position at a control point. The value is an integer index with the range [1, number of control points].
-parameter	This optional flag is the notification to get the position at a parameter. The value is a float in the range [0.0, 1.0] or a uv vector with v ignored.
-arc	This optional flag is the notification to get the position at an arc length. The value is a normalized float arc length from the start of the connector in the range [0.0, 1.0].
-X	This optional flag is the notification to get the position at a constant X. The value is a float constant X coordinate value.
-Y	This optional flag is the notification to get the position at a constant Y. The value is a float constant Y coordinate value.
-Z	This optional flag is the notification to get the position at a constant Z. The value is a float constant Z coordinate value.
-closest	This optional flag is the notification to get the closest position. The value is a point, or grid coord.
value	This required parameter is the float or integer value to get the position.

Returns

This action returns a point giving the position on the connector which may be in the form “u v dbentity”.

Information

If the connector is defined in model space, an xyz vector will be returned. If the connector is defined by a database, the position will be returned in database parameter space.

Example

This example shows how to get the position at a constant X value on a connector. This connector was created on a database entity. $con(1) is referencing an existing connector.

Code

puts [pw::Application getDescription [$con(1) getPosition -X 3]]

Output

curve-1 (0.6,0)

getXYZ

$con getXYZ ?< -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest >? value

This action gets the model space position on a connector.

Parameters

-grid	This optional flag is the notification to get the position at a grid point. value is an integer index [1, number of grid points]. This is the default option.
-control	This optional flag is the notification to get the position at a control point. The value is an integer index with the range [1, number of control points].
-parameter	This optional flag is the notification to get the position at a parameter. The value is a float in the range [0.0, 1.0] or a uv vector with v ignored.
-arc	This optional flag is the notification to get the position at an arc length. The value is a normalized float arc length from the start of the connector in the range [0.0, 1.0].
-X	This optional flag is the notification to get the position at a constant X. The value is a float constant X coordinate value.
-Y	This optional flag is the notification to get the position at a constant Y. The value is a float constant Y coordinate value.
-Z	This optional flag is the notification to get the position at a constant Z. The value is a float constant Z coordinate value.
-closest	This optional flag is the notification to get the closest position. The value is a point or grid coord.
value	This required parameter is the value to get the coordinate.

Returns

This action returns an XYZ vector.

Example

This example shows how to get the model space position at 3/4 the the length of a connector. $con(1) is referencing an existing connector.

Code

puts [$con(1) getXYZ -arc [list 0.75]]

Output

3.75 2.0 0.0

getParameter

$con getParameter ?< -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest >? value

This action gets a parameter value on a connector.

Parameters

-grid	This optional flag is the notification to get the position at a grid point. value is an integer index [1, number of grid points]. This is the default option.
-control	This optional flag is the notification to get the position at a control point. The value is an integer index with the range [1, number of control points].
-parameter	This optional flag is the notification to get the position at a parameter. The value is a float in the range [0.0, 1.0] or a uv vector with v ignored.
-arc	This optional flag is the notification to get the position at an arc length. The value is a normalized float arc length from the start of the connector in the range [0.0, 1.0].
-X	This optional flag is the notification to get the position at a constant X. The value is a float constant X coordinate value.
-Y	This optional flag is the notification to get the position at a constant Y. The value is a float constant Y coordinate value.
-Z	This optional flag is the notification to get the position at a constant Z. The value is a float constant Z coordinate value.
-closest	This optional flag is the notification to get the closest position. The value is a point or grid coord.
value	This required parameter is the integer or float value to get the parameter.

Returns

This action returns the float parameter of the connector.

Information

The -parameter value option only returns the given value clamped to [0.0, 1.0]. It is included for consistency with other commands.

Example

This example shows how to get the parameter value of a grid point on a connector. $con(1) is referencing an existing connector.

Code

puts [$con(1) getParameter -grid 2]

Output

0.25

getGeometricProperties

$con getGeometricProperties ?-curve curveVar? ?-surface surfaceVar? ?-directional directionalVar? ?-orthogonal orthogonalVar? ?< -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest >? value

This action calculates the geometric properties at the specified position on the connector.

Parameters

-curve curveVar	This optional parameter is the string name of a variable to receive an array of curve-based geometric properties. The array indices and the values are listed below.
-surface surfaceVar	This optional parameter is the string name of a variable to receive an array of surface-based geometric properties, if the specified position is constrained to a surface. The array indices and the values are listed below.
-directional directionalVar	This optional parameter is the string name of a variable to receive an array of surface-based geometric properties in the direction of the connector, if the specified position is constrained to a surface. The array indices and the values are listed below.
-orthogonal orthogonalVar	This optional parameter is the string name of a variable to receive an array of surface-based geometric properties in the direction orthogonal to the connector, if the specified position is constrained to a surface. The array indices and the values are listed below.
-grid	This optional flag is the notification to get the geometric properties at a grid point. value is an integer index [1, number of grid points]. This is the default option.
-control	This optional flag is the notification to get the geometric properties at a control point. The value is an integer index in the range [1, number of control points].
-parameter	This optional flag is the notification to get the geometric properties at a parameter. The value is a float in the range [0.0, 1.0] or a uv vector with v ignored.
-arc	This optional flag is the notification to get the geometric properties at an arc length. The value is a normalized float arc length from the start of the connector in the range [0.0, 1.0].
-X	This optional flag is the notification to get the geometric properties at a constant X. The value is a float constant X Cartesian coordinate value.
-Y	This optional flag is the notification to get the geometric properties at a constant Y. The value is a float constant Y Cartesian coordinate value.
-Z	This optional flag is the notification to get the geometric properties at a constant Z. The value is a float constant Z Cartesian coordinate value.
-closest	This optional flag is the notification to get geometric properties at the closest position. The value is a point or grid coord.
value	This required parameter is the integer or float position value.

Returns

This action returns nothing.

Curve-based Geometry Properties Array

This array is divided into the following elements.

Point	This element is the vector location of the connector that these geometric properties are for.
UV	This is the vector non-normalized UV parameter of the underlying connector shape.
LimitsU	This is the vector non-normalized parameter limits in U of the underlying connector shape.
LimitsV	This is the vector non-normalized parameter limits in V of the underlying connector shape.
RadiusOfCurvature	This element is the float radius of curvature of the connector.
Normal	This element is the vector normal of the connector.
Tangent	This element is the vector tangent of the connector.

Surface-based Geometry Properties Array

This array is divided into the following elements. If the connector is not constrained to a surface, the elements will be set to 0. If the connector is constrained to multiple surfaces, the surface with the smallest minimum radius of curvature will be used for all properties.

Point	This element is the point on the surface that the connector is constrained to and these surface geometric properties are for.
UV	This is the vector non-normalized UV parameter of the surface that the connector is constrained to.
LimitsU	This is the vector non-normalized parameter limits in U of the surface that the connector is constrained to.
LimitsV	This is the vector non-normalized parameter limits in V of the surface that the connector is constrained to.
RadiusOfCurvature	This element is the float minimum radius of curvature.
GaussianCurvature	This element is the float gaussian curvature in radians per unit length.
AverageCurvature	This element is the float average curvature in radians per unit length.
MinimumCurvature	This element is the float minimum curvature in radians per unit length.
MaximumCurvature	This element is the float maximum curvature in radians per unit length.
Normal	This element is the vector normal of the surface.
Principal	This element is the vector principal tangent of the surface, which points in the direction of minimum curvature.
dPdU	This element is the vector first partial derivative in U.
dPdV	This element is the vector first partial derivative in V.
d2PdU2	This element is the vector second partial derivative in U.
d2PdUdV	This element is the vector second partial derivative in UV.
d2PdV2	This element is the vector second partial derivative in V.

Directional and Orthogonal Surface-based Geometry Properties Array

RadiusOfCurvature	This element is the float radius of curvature in the direction of (or orthogonal to) the connector.
Direction	This element is the vector derivative of (or orthogonal to) the connector.
DirectionUV	This element is the vector derivative of (or orthogonal to) the connector in the UV parameter space of the surface.
dPdD	This element is the vector first derivative of the surface in the direction given by the DirectionUV element.
d2PdD2	This element is the vector second derivative of the surface in the direction given by the DirectionUV element.

getTransverseAngle

$con getTransverseAngle < ?-tolerance tol? | ?-toleranceMultiplier multiplier? | ?-sampleDistance distance? > ?-type typeVar? ? < -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest > ? value

This action gets the transverse angle, in degrees, at a position on a connector in the defining space of the connector, and optionally whether the connector is convex or concave at that position.

Parameters

-tolerance tolerance	This optional parameter is the float value of the tolerance. If not specified the maximum assemble tolerance for the connector returned by pw::Connector.getAssembleTolerance is used.
-toleranceMultiplier multiplier	This optional parameter is the float value to apply to the assembly tolerance (whether provided in the -tolerance or the default). The default value of this parameter is 2.0.
-sampleDistance distance	This optional parameter is the float explicit distance to use in lieu of using the tolerance multiplier and assembly tolerance.
-type typeVar	This optional parameter is the string name of a variable to hold the string value of CONVEX or CONCAVE, depending on whether the connector is convex or concave at the requested position.
-grid	This optional flag is the notification to get the position at a grid point. The value is an integer index [1, number of grid points]. This is the default option.
-control	This optional flag is the notification to get the position at a control point. The value is an integer index with the range [1, number of control points].
-parameter	This optional flag is the notification to get the position at a parameter. The value is a float in the range [0.0, 1.0] or a uv vector with v ignored.
-arc	This optional flag is the notification to get the position at an arc length. The value is a normalized float arc length from the start of the connector in the range [0.0, 1.0].
-X	This optional flag is the notification to get the position at a constant X. The value is a float constant X Cartesian coordinate value.
-Y	This optional flag is the notification to get the position at a constant Y. The value is a float constant Y Cartesian coordinate value.
-Z	This optional flag is the notification to get the position at a constant Z. The value is a float constant Z Cartesian coordinate value.
-closest	This optional flag is the notification to get the closest position. The value is a point or grid coord.
value	This required parameter is the float or integer value to get the position at from which the transverse angle is determined.

Returns

This action returns the transverse angle of the connector at the requested position in degrees.

Information

This command only works for a connector that is shared by two domains and has more than 2 grid points. The transverse angle is determined from the surface normals by snapping the position to the database surfaces (for each domain). If the optional typeVar parameter is supplied, whether the position lies on a convex or concave shared boundary between two databases surfaces (one from each domain) is determined. Also note that the assembly tolerance and tolerance multiplier can both or separately be specified, but neither can be if sample distance is specified, and vice versa.

Example

This example shows how to get the transverse angle and concavity at a grid position on a connector. This connector was created on a database entity. $con(1) is referencing an existing connector.

Code

puts "$con(1) transverse angle: [$con(1) getTransverseAngle -type\
    typeVar -grid 3], concavity: $typeVar"

Output

curve-1 transverse angle: 90, concavity: CONVEX

getLength

$con getLength ?< -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest >? value

This action gets the connector length from the beginning to a given location.

Parameters

-grid	This optional flag is the notification to get the length at a grid point. The value is an integer index [1, number of grid points]. This is the default option.
-control	This optional flag is the notification to get the length at a control point. The value is an integer index with the range [1, number of control points].
-parameter	This optional flag is the notification to get the length at a parameter. The value is a float in the range [0.0, 1.0] or a uv vector with v ignored.
-arc	This optional flag is the notification to get the length at an arc length. The value is a normalized float arc length from the start of the connector in the range [0.0, 1.0].
-X	This optional flag is the notification to get the length at a constant X. The value is a float constant X Cartesian coordinate value.
-Y	This optional flag is the notification to get the length at a constant Y. The value is a float constant Y Cartesian coordinate value.
-Z	This optional flag is the notification to get the length at a constant Z. The value is a float constant Z Cartesian coordinate value.
-closest	This optional flag is the notification to get the closest position. The value is a point or grid coord.
value	This required parameter is the integer or float value to get the length.

Returns

This action returns the float curve length.

Information

The -arc value option converts value from a normalized to a non-normalized length. It is included for consistency with other commands.

Example

This example shows how to get the length along a connector from the point on the connector closest to the given point. $con(1) is referencing an existing connector.

Code

puts [$con(1) getLength -closest "4.5 1 0"]

Output

6.985033540042618

$con setDimension 5
puts "getPointCount: [$con getPointCount]"
puts "getCellCount: [set cnt [$con getCellCount]]"
set cells [$con getCells]
for {set i 0} { $i < $cnt } {incr i} {
puts "cell [expr $i + 1]: \{ [lindex $cells $i] \}"
}

pw:: Connector

Derives From

Static Actions

create

Parameters

Returns

See Also

Example

createOnDatabase

Parameters

Returns

Information

See Also

Example

createFromPoints

Parameters

Note

Returns

See Also

Example

join (static)

Parameters

Note

Returns

Information

See Also

Example

getBestSegment

Parameters

Returns

Example

getConnectorsFromNode

Parameters

Returns

Example

getConnectorsFromSpacing

Parameters

Returns

See Also

Example

getAdjacentConnectors

Parameters

Returns

Information

Example

getConnectorsInPlane

Parameters

Returns

doConnectorsGetDimension

Parameters

Returns

See Also

Example

getInvalidDistributions

Parameters

Returns

Information

Example

setDimensionFromSizeField

Parameters

Returns

See Also

synchronizeSpacings

Parameters

Information

Returns

applyTRex (static)

Parameters

Information

Returns

See Also

swapDistribution

Parameters

Returns

See Also

Example

Static Defaults

Dimension (Default)

Type

Default