API reference - Class MarkerNotation used in Ruby API documentation 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. Public constructors
Public methods
Deprecated methods (protected, public, static, non-static and constructors)
Detailed descriptionvoid _createDescription: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. void _destroyDescription: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. [const] bool _destroyed?Description: Returns a value indicating whether the object was already 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] bool _is_const_object?Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. void _manageDescription: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. void _unmanageDescription: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. [const] unsigned int colorDescription: Get the color of the marker This value is valid only if has_color? is true. Python specific notes:The object exposes a readable attribute 'color'. This is the getter. void 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. Python specific notes:The object exposes a writable attribute 'color'. This is the setter. void createDescription: Ensures the C++ object is created Use of this method is deprecated. Use _create instead void destroyDescription: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead [const] int dither_patternDescription: Get the stipple pattern index See dither_pattern= for a description of the stipple pattern index. Python specific notes:The object exposes a readable attribute 'dither_pattern'. This is the getter. void 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. Python specific notes:The object exposes a writable attribute 'dither_pattern'. This is the setter. [const] unsigned int frame_colorDescription: Get the frame color of the marker This value is valid only if has_frame_color? is true.The set method has been added in version 0.20. Python specific notes:The object exposes a readable attribute 'frame_color'. This is the getter. void frame_color=(unsigned int color)Description: Set the frame 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_frame_color, in which case the fill color is used. The set method has been added in version 0.20. Python specific notes:The object exposes a writable attribute 'frame_color'. This is the setter. [const] int haloDescription: Get the halo flag See halo= for a description of the halo flag. Python specific notes:The object exposes a readable attribute 'halo'. This is the getter. void 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. Python specific notes:The object exposes a writable attribute 'halo'. This is the setter. [const] bool has_color?Description: True, if the marker has a specific color [const] bool has_frame_color?Description: True, if the marker has a specific frame color The set method has been added in version 0.20. [const] bool is_const_object?Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead [const] int line_widthDescription: Get the line width of the marker See line_width= for a description of the line width. Python specific notes:The object exposes a readable attribute 'line_width'. This is the getter. void line_width=(int width)Description: Set the line width of the marker This is the width of the line drawn for the outline of the marker. Python specific notes:The object exposes a writable attribute 'line_width'. This is the setter. [static] new Marker ptr new(LayoutView ptr view)Description: The constructor for a marker A marker is always associated with a view, in which it is shown. The view this marker is associated with must be passed to the constructor. Python specific notes:This method is the default initializer of the object void reset_colorDescription: Reset the color of the marker See set_color for a description of the color property of the marker. void reset_frame_colorDescription: Reset the frame color of the marker See set_frame_color for a description of the frame color property of the marker.The set method has been added in version 0.20. void set(const DBox box)Description: Set the box the marker is to display Makes the marker show a box. The box must be given in micron units. If the box is empty, no marker is drawn. The set method has been added in version 0.20. void set(const DText text)Description: Set the text the marker is to display Makes the marker show a text. The text must be given in micron units. The set method has been added in version 0.20. void set(const DEdge edge)Description: Set the edge the marker is to display Makes the marker show a edge. The edge must be given in micron units. The set method has been added in version 0.20. void set(const DPath path)Description: Set the path the marker is to display Makes the marker show a path. The path must be given in micron units. The set method has been added in version 0.20. void set(const DPolygon polygon)Description: Set the polygon the marker is to display Makes the marker show a polygon. The polygon must be given in micron units. The set method has been added in version 0.20. void set_box(const DBox box)Description: Set the box the marker is to display Makes the marker show a box. The box must be given in micron units. If the box is empty, no marker is drawn. The set method has been added in version 0.20. void set_edge(const DEdge edge)Description: Set the edge the marker is to display Makes the marker show a edge. The edge must be given in micron units. The set method has been added in version 0.20. void set_path(const DPath path)Description: Set the path the marker is to display Makes the marker show a path. The path must be given in micron units. The set method has been added in version 0.20. void set_polygon(const DPolygon polygon)Description: Set the polygon the marker is to display Makes the marker show a polygon. The polygon must be given in micron units. The set method has been added in version 0.20. void set_text(const DText text)Description: Set the text the marker is to display Makes the marker show a text. The text must be given in micron units. The set method has been added in version 0.20. [const] int vertex_sizeDescription: Get the vertex size of the marker See vertex_size= for a description. Python specific notes:The object exposes a readable attribute 'vertex_size'. This is the getter. void vertex_size=(int size)Description: Set the vertex size of the marker This is the size of the rectangles drawn for the vertices object. Python specific notes:The object exposes a writable attribute 'vertex_size'. This is the setter. |