CDShapeInitialize < Main

Tags: view all tags
---+ .SHAPE INITIALIZE

_This subroutine is called to initialize or reinitialize a shape spec._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;shape_name&gt;          FIELD            SHARE? N
      PASS         &lt;shape_id&gt;            FIELD            SHARE? N
      PASS         &lt;no_of_points&gt;        FIELD            SHARE? N
      GOSUB    OCD .SHAPE INITIALIZE
      *        Check for error
      IF       OCD .SHAPE INITIALIZE          NE</pre>
---++ Description:

<div id="_mcePaste">This initializes or reinitializes the specified shape specification. Initialization removes the specified shape and everything is reset to defaults.</div>

The &lt;shape_name&gt; and &lt;shape_id&gt; are required parameters, and the subroutine will cancel if they are not received.

&lt;shape_name&gt; can be any name you prefer.

&lt;shape_id&gt; must be one of the following:

squareShape, diamondShape, triangleShape, rightTriangleShape, leftTriangleShape, invertedTriangleShape, circleShape, glassSphereShape, glassSphere2Shape, solidSphereShape, starShape, polygonShape, polygon2Shape, crossShape, cross2Shape, and customShape.

For &lt;shape_ID&gt;'s equal to "CustomShape", the designer must add the x,y coordinates of the vertices using [[CDShapeSetNextPoint][.SHAPE SET NEXT POINT]] for each vertice.

For the Polygon shapes, you must also pass &lt;no_of_points&gt; for the number of sides (must be &gt;3). For starShape, you must pass &lt;no_of_points&gt; for the number of points on the star (must be &gt;3). For the cross shapes, you must pass a value between 0 and 1 to represent the percentage width of the arms of the a '+' relative to the entire shape.

Once your shape is initialized, you can assign it via [[CDXYSetBarShape][.XY SET BAR SHAPE]].

The newly initialized shape is set to be the "current" shape.
---++ Comments:

_Read what other users have said about this page or add your own comments._

<br />%COMMENT%

-- Main.JeanNeron - 2011-10-20
Topic revision: r4 - 2012-02-25 - JeanNeron