Ahelp: get_point - ChIPS 4.1

Description

id - an optional ChipsId structure containing values to modify the currency state for the command or a string id to specify a point within the current frame.
attribute - a string containing the name of the attribute to retrieve

The get_point command returns a structure containing all the attribute values of the point. To retrieve the value of a specific attribute, provide the attribute name and the id or ChipsId of the object.

Some values are set to "None" in the returned structure. These entries generally correspond to attributes which may only be modified at creation time, such as the object id.

The attributes associated with points are:

Attribute	Description
angle	Angle at which the point is drawn
color	Color of the point
depth	Integer value indicating point depth
fill	Controls whether the point is displayed as an outline or solid
size	size of the point
style	Symbol style of the point

To see if a point is hidden or visible, use the get_point_visible command.

Advanced Functions

The module of advanced ChIPS functions contains other commands for retrieving attribute values (refer to "ahelp chips" for information on loading the module):

get_point_angle
get_point_color
get_point_depth
get_point_fill
get_point_size
get_point_style

Example 1

chips> add_point(.1, .1, "style=diamond");
chips> print(get_point());
chips> print(get_point("pnt1","style"));

A point is created and becomes current. Calling get_point with no argument returns all the attributes of the object. get_point is called a second time to return just the "style" attribute.

Example 2

chips> add_point(.1, .1, "style=diamond");
chips> add_point(.2, .2, "style=cross");
chips> print(get_point("pnt1"));

Two points are created. get_point is called with the id of the first point, returning all attributes.

Example 3

chips> id=ChipsId();
chips> id.point="pnt1";
chips> print(get_point(id));

A ChipsId structure is created and the id.point field is set to "pnt1". get_point is called with the ChipsId.

Example 4

chips> pntatt=get_point;
chips> print(pntatt);

Retrieve a structure containing the attribute values of the current point and store the results in "pntatt". Print the contents of "pntatt".

get_point

Synopsis

Syntax