ccSpiralConnector
ccSpiralConnector(
n_lengthInnerSpiral0
n_lengthOuterSpiral1
x_numberOfTurns
n_minRadius
n_gamma
[ ?portLocation t_location ]
)
=> l_connector / nil
Description
(Virtuoso Photonics Option) Creates a spiral connector that consists of an inner S-shaped figure of two joined circular bend connectors. Each endpoint of S is prolonged by a straight extension and then by N-turnings of a spiral circling around S.
Arguments
|
n_lengthInnerSpiral0
|
|
|
Size of the innermost turn of the spiral, L0.
|
|
n_lengthOuterSpiral1
|
|
|
Size of the outermost turn of the spiral L!.
|
|
x_numberOfTurns
|
Number of turns on the left and right part of the spiral. Total number of turns is 2 * x_N.
|
|
n_minRadius
|
Minimum allowed curvature radius.
|
|
n_gamma
|
A numeric value between 0 and 1, indicating a ratio of the circular bending angle to the overall bending angle.
When the value is 1, each turn of spiral consists of a single circular arc.
When the value is 0, each turn of spiral consists of two clothoids.
|
|
?portLocation t_location
|
|
|
Location of the ports.
Valid values: "center", "side"
The default is "center", which means the default spiral connector with the location of the ports as shown in the above figure.
When set to "side" the default spiral connector is extended by additional connector segments (shown in red) such that the ports are located at the sides at the top of the spiral.
|
Value Returned
|
l_connector
|
list(nil 'connector o_polyCurve 'message t_message)
The resulting connector and a message string where,
-
o_polyCurve is the ID of the resulting ccPolyCurve connector. If
o_polyCurve = nil, the connector cannot be implemented. -
t_message is a string holding the debug printouts and error messages.
|
|
nil
|
An error occurred, the connector cannot be implemented.
|
Example
ccSpiralConnector(50 100 3 6 0)
=> (nil connector cc@0xc8c2798a message "Length=2162.349132 MinRadius=6.000000")
Related Topics
Curvy Core Connector Functions
Return to top
