Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

enterCircle

enterCircle(
[ ?prompts l_promptList ] 
[ ?points l_pointList ] 
[ ?form s_form ] 
[ ?addPointProc t_addProcName ] 
[ ?delPointProc t_delProcName ] 
[ ?initProc t_initProcName ] 
[ ?doneProc t_doneProcName ]
[ ?formProc t_formProcName ]
[ ?dontDraw g_dontDraw ]
[ ?alwaysMap g_alwaysMap ]
[ ?acceptString g_acceptString ]
[ ?acceptNumber g_acceptNumber ]
[ ?noInfix g_noInfix ]
[ ?cmdName t_cmdName ]
[ ?cursor x_cursor ]
) 
=> l_bBox / nil

Description

Enters a circle in the current window.

Arguments

?prompts l_promptList

  

List of prompt strings to appear on the CIW prompt line. If supplied, only the first two strings are used. The first string corresponds to the center, which is the first point entered, and the second string corresponds to a point on the circumference.

?points l_pointList

  

List of no more than two points. If both points are supplied, they are returned after adjustment with no further interaction. If one point is supplied, it is adjusted and you are prompted to enter the second point. The first point entered is the center of the circle. After entry, a rubberbanding circle appears about the center and passing through the cursor. When the second point is entered, the bounding box of the circle is computed and returned.

?form s_form

Options form created with hiCreateOptionsForm. This form is displayed when you call hiToggleEnterForm. It contains options relevant to the enterfunction and its caller.

?addPointProc t_addProcName

  

Name of the SKILL function to be called when a point is entered.

?delPointProc t_delProcName

  

Name of the SKILL function to be called when a point is deleted.

?initProc t_initProcName

  

Name of the SKILL function to be called immediately after the enterfunction is started and before any data entry.

?doneProc t_doneProcName

  

Name of the SKILL function to be called when the enterfunction is terminated.

?formProc t_formProcName

  

Name of the SKILL function to be called when the options form is displayed.

?dontDraw g_dontDraw

  

Determines whether or not to draw rubber band lines.

?alwaysMap g_alwaysMap

  

Determines whether or not to immediately display the options form.

?acceptString g_acceptString

  

Determines whether or not to accept string input without terminating the enterfunction.

?acceptNumber g_acceptNumber

  

Determines whether or not to accept numeric input without terminating the enterfunction.

?noInfix g_noInfix

  

Determines whether or not to disable infix mode.

?cmdName t_cmdName

  

Name you associate with the enterfunction. If the command name is set, it can be accessed with hiGetCurrentCmd.

?cursor x_cursor

An integer argument that will default to an appropriate cursor. For example, hicArrowRectangle for enterBox and hicArrowArc for enterArc. For more information on all available cursors see hiSetCursor.

Value Returned

l_bBox

A list containing the bounding box of the circle.

nil

A nil list is returned.

Retrieve data through the callback procedure t_doneProcName instead of using the return value for this enterfunction.

Examples

Displays the prompt Enter the circle center on the CIW prompt line.

procedure( circleInit( w )
   leSetEntryLayer( list("pdiff" "drawing"))
)
procedure( circleDone( w done pts )
   if( done then
      printf("Circle entered was %L. Layer is %L.\n" pts
         leGetEntryLayer( ))
   else
      println("Circle entry aborted.")
   )
)
enterCircle( ?prompts list( "Enter the circle center."
   "Enter a point on the circumference." )
   ?doneProc "circleDone" ?initProc "circleInit"
)

The initProc forces the window current layer and purpose pair to be (“pdiff” “drawing”). When you enter point p1 the prompt changes to Enter a point on the circumference. A rubberband circle appears with center p1 and passing through the cursor. Enter point p2 and doneProc prints the circle points:

Circle entered was ( p1 p2 ). Layer is ("pdiff" "drawing").

Here, (c1 c2) is the bounding box of the circle entered. The enterfunction returns a list of the circle points:

( c1 c2 )

Related Topics

User Entry Functions

hiCreateOptionsForm

undrawEnterFun

hiGetCurrentCmd


Return to top
 ⠀
X