Brief Index      Full Index      I.M. Reference

Set_Edge_Pattern_Explicit


Functions

void Set_Edge_Pattern_Explicit (const char *pattern)
void Set_Edge_Pattern_Explicit_By_Key (HC_KEY key, const char *pattern)

Function Documentation

void Set_Edge_Pattern_Explicit ( const char *  pattern  ) 

Applies line style and inner joins options to the edges of polygons, circles, ellipses, shells, and meshes.

Parameters:
pattern - A quoted string or a string variable containing a list of the desired pattern settings.

DETAILS

Declares, changes, or removes a value for the Edge Pattern attribute. This allows a pattern to be applied to the geometric edges of the filled shapes on the screen. Edge Pattern is one of the ways of highlighting one collection of edges against the others in your scene.

Supported Options:
line style, inner cap, join
[no] line style

Specifies a line style that was defined in Define_Line_Style() or any line pattern description that is legally accepted in Set_Edge_Pattern().

[no] inner cap(s) = [symbol]

Specify a symbol to be used to cap segments within the edge. Note that inner caps have no effect if the edge pattern is not broken. In other words, inner caps will not appear on a edge pattern with no blanks between the dashes. Possible symbols are as follows:

-------------------------------------------------------------
'#' square (hash symbol)          A "square" segment cap.
'^' pointy (carat symbol)         A "mitre" segment cap.
'@' round  ("at" symbol)          A "round" line segment cap.
-------------------------------------------------------------

[no] join(s) = [symbol]

Specifies a symbol to be used in the joins of the edge. The possible symbols are as follows:

-------------------------------------------------------------
'<' mitre  (right angle bracket)  A "mitre" line join.
'|' bevel  (right square bracket) A "bevel" line join.
'(' round  (right parenthesis)    A "round" line join.
-------------------------------------------------------------

Note that if you specify the left parenthesis symbol for a "round" line join, it must be in a surrounded by singles quotes to remove any ambiguity that might occur about the syntax of the options string.

NOTES

Edges may be turned off entirely with Set_Visibility() .

RESTRICTIONS

See also:
Set_Edge_Pattern, Set_Edge_Weight, Show_Edge_Pattern_Explicit, Set_Color, Set_Face_Pattern, Insert_Polygon, Insert_Shell, Insert_Mesh, Insert_Circle, Insert_Ellipse, Set_Visibility.

void Set_Edge_Pattern_Explicit_By_Key ( HC_KEY  key,
const char *  pattern 
)

Similar to Set_Edge_Pattern_Explicit(), but operates on a given segment rather than the currently open one.

Parameters:
key - key associated with the segment to be changed.
pattern - A quoted string or a string variable containing a list of the desired pattern settings.

DETAILS

No additional details. See Set_Edge_Pattern_Explicit().

Main Index
Brief Index      Full Index      I.M. Functions