.\"##
.\" $XConsortium: p246,v 5.2 94/04/17 20:57:18 rws Exp $
.\"##
.\"## 
$XMCOPY
.\"## Copyright (c) 1990, 1991 by Sun Microsystems, Inc. 
.\"## 
.\"##                         All Rights Reserved
.\"## 
.\"## Permission to use, copy, modify, and distribute this software and its 
.\"## documentation for any purpose and without fee is hereby granted, 
.\"## provided that the above copyright notice appear in all copies and that
.\"## both that copyright notice and this permission notice appear in 
.\"## supporting documentation, and that the name of Sun Microsystems,
.\"## not be used in advertising or publicity 
.\"## pertaining to distribution of the software without specific, written 
.\"## prior permission.  
.\"## 
.\"## SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 
.\"## INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\"## EVENT SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\"## CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
.\"## USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
.\"## OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\"## PERFORMANCE OF THIS SOFTWARE.
.TH "POLYMARKER" 3P "29 February 1991"
.SH NAME
POLYMARKER \- create structure element specifying \s-2\&2D\s+2 polymarker primitive
.IX "Marker Primitives" "POLYMARKER"
.IX "Primitives, Marker Primitives" "POLYMARKER"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
ppolymarker ( point_list )
Ppoint_list	*point_list;	\fIlist of points\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
The \s-2POLYMARKER\s+2 function puts the full specification of a \s-2
POLYMARKER\s+2 primitive into the currently open structure.  A
\s-2POLYMARKER\s+2 primitive is a series of markers, such as dots, plus
signs, asterisks, circles, or \fIx\fP's, drawn in the display at specified
Modelling Coordinate (\s-2MC\s+2) points on the \fIz\fP \(eq 0 plane.
.SS C Input Parameters
.IP \fIpoint_list\fP
A pointer to a Ppoint_list structure containing a list of Ppoint structures,
which contain the \fIx\fP and \fIy\fP coordinates for each point at which
markers will be placed.
.IP
The Ppoint_list structure is defined in phigs.h as follows:
.sp .4
.ta .5i +\w'Ppoint	'u +\w'num_points;     'u
.nf
typedef struct  {
.sp .2
	Pint	num_points;	/* number of Ppoint elements in the list */
	Ppoint	*points;	/* list of points */
.sp .2
} Ppoint_list;
.sp .4
.fi
The \fInum_points\fR component specifies the number of elements in the list.
The \fIpoints\fR component is a pointer to a list of Ppoints \fInum_points\fR long.
The Ppoint structure is defined in phigs.h as follows:
.sp .4
.ta .5i +\w'Pfloat     'u +\w'x;     'u
.nf
typedef struct  {
.sp .2
	Pfloat	x;	/* x coordinate */
	Pfloat	y;	/* y coordinate */
.sp .2
} Ppoint;
.fi
.SS Execution
.LP
If the current edit mode is \s-2INSERT\s+2, the \s-2POLYMARKER\s+2
element is inserted in the open structure after the element pointed at by
element pointer. If the current edit mode is \s-2REPLACE\s+2, the
\s-2POLYMARKER\s+2 element replaces the element pointed to by the element
pointer.  In either case, the element pointer is updated to point to the
new \s-2POLYMARKER\s+2 element.
.LP
When the structure is traversed, the \s-2POLYMARKER\s+2 element places a
marker at each of the coordinate locations specified. The current values
of the attributes listed below will be applied to the marker.
.LP
The coordinates used to specify the polymarker primitive are \s-2MC\s+2s.
These may be any coordinate units that are convenient to the
application. At traversal, these coordinate values are transformed by the
current local and global modelling transformations,
the view representation selected by the current view index,
and the workstation transformation current on the
workstation to which the structure is posted.
.\"See Chapter 7, "The Transformation Pipeline," in the \fI\s-2PEX-SI\s0
.\"Programming Guide\fP for more information.
.SS Attributes Applied
The attributes listed below are used to display the
\s-2POLYMARKER\s+2 primitive when the structure is traversed. The Aspect Source 
Flags (\s-2ASF\s+2s) tell where to access the output display attributes. 
These attributes can come directly from the traversal state list,
or they can be accessed indirectly, using the appropriate index 
in the traversal state list and the corresponding bundled 
representation in the PHIGS workstation state list.
.RS
.nf
.ta .5i +\w'back interior reflectance equation   'u 
.sp
marker type			marker type \s-2ASF\s+2
marker size scale factor	marker size scale factor \s-2ASF\s+2
polymarker colour		polymarker colour index \s-2ASF\s+2
polymarker index
depth cue index
name set
.fi
.RE
.sp .2
.SH ERRORS
.IP 005
Ignoring function, function requires state (\s-2PHOP, *, STOP, *\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INQUIRE POLYMARKER FACILITIES (3P)"
.SM "POLYMARKER 3 (3P)"
.fi
