Class Marker (version 0.18)

Description: The floating-point coordinate marker object

The marker is a visual object that "marks" (highlights) a certain area of the layout, given by a database object. This object accepts database objects with floating-point coordinates in micron values.

Class overview

Index

Method Overview

[static] Marker new( ref LayoutView view ) The constructor for a marker

set_box( DBox box ) Set the box the marker is to display

set_text( DText text ) Set the text the marker is to display

set_edge( DEdge edge ) Set the edge the marker is to display

set_path( DPath path ) Set the path the marker is to display

set_polygon( DPolygon polygon ) Set the polygon the marker is to display

color=( unsigned int color ) Set the color of the marker

reset_color Reset the color of the marker

[const] unsigned int color Get the color of the marker

[const] bool has_color? True, if the marker has a specific color

line_width=( int width ) Set the line width of the marker

[const] int line_width Get the line width of the marker

vertex_size=( int size ) Set the vertex size of the marker

[const] int vertex_size Get the vertex size of the marker

halo=( int halo ) Set the halo flag

[const] int halo Get the halo flag

dither_pattern=( int index ) Set the stipple pattern index

[const] int dither_pattern Get the stipple pattern index

destroy Explicitly destroy the object

[const] bool destroyed Tell, if the object was destroyed

[const] unsigned int color

Description: Get the color of the marker

This value is valid only if has_color? is true.

color=( unsigned int color )

Description: Set the color of the marker

The color is a 32bit unsigned integer encoding the RGB values in the lower 3 bytes (blue in the lowest significant byte). The color can be reset with reset_color, in which case, the default foreground color is used.

destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed

Description: Tell, if the object was destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] int dither_pattern

Description: Get the stipple pattern index

See dither_pattern= for a description of the stipple pattern index.

dither_pattern=( int index )

Description: Set the stipple pattern index

A value of -1 or less than zero indicates that the marker is not filled. Otherwise, the value indicates which pattern to use for filling the marker.

[const] int halo

Description: Get the halo flag

See halo= for a description of the halo flag.

halo=( int halo )

Description: Set the halo flag

The halo flag is either -1 (for taking the default), 0 to disable the halo or 1 to enable it. If the halo is enabled, a pixel border with the background color is drawn around the marker, the vertices and texts.