Class LayerPropertiesNode (version 0.18)Description: A layer properties node structure This class is derived from LayerProperties. Objects of this class are used in the hierarchy of layer views that are arranged in a tree while the LayerProperties object reflects the properties of a single node.
Method Overview
[const] bool !=( LayerProperties other )Description: Inequality
[const] bool !=( LayerPropertiesNode other )Description: Inequality
[const] bool ==( LayerPropertiesNode other )Description: Equality
[const] bool ==( LayerProperties other )Description: Equality
[const] int animation( bool )Description: Get the animation state The animation state is an integer either being 0 (static), 1 (scrolling), 2 (blinking) or 3 (inversely blinking)
animation=( int animation )Description: Set the animation state See the description of the animation method for details about the animation state
assign( LayerPropertiesNode other )Description: Assign the contents of another object to self This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.
[const] DBox bboxDescription: Compute the bbox of this layer This takes the layout and path definition (supported by the given default layout or path, if no specific is given). The node must have been attached to a view to make this operation possible.
[const] int cellviewDescription: Access to the the cellview index This is the index of the actual cellview to use. Basically, this method returns source_cellview in "real" mode. The result may be different, if the cellview is not valid for example. In this case, a negative value is returned.
clear_dither_patternDescription: Clear the dither pattern
clear_fill_colorDescription: Reset the fill color
clear_frame_colorDescription: Reset the frame color
clear_lower_hier_levelDescription: Disable a lower hierarchy level specification See has_lower_hier_level for a description of this property
clear_source_nameDescription: Remove any stream layer name specification from this layer
clear_upper_hier_levelDescription: Disable a upper hierarchy level specification See has_upper_hier_level for a description of this property
destroyDescription: 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 destroyedDescription: 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( bool real )Description: Get the dither pattern index This method may deliver an invalid dither pattern index if it is not set.
dither_pattern=( int index )Description: Set the dither pattern index The dither pattern index must be one of the valid indices. Indices 0 to 31 denote built-in pattern, indices above 32 denote one of the custom pattern. Index 0 is always solid filled and 1 is always the hollow filled pattern.
[const] LayerPropertiesNode dupDescription: Creates a copy of self.
[const] unsigned int eff_dither_pattern( bool real )Description: Get the effective dither pattern index The effective dither pattern index is always a valid index, even if no dither pattern is set.
[const] unsigned int eff_fill_color( bool real )Description: Get the effective frame color The effective frame color is computed from the frame color brightness and the frame color.
[const] unsigned int eff_frame_color( bool real )Description: Get the effective frame color The effective frame color is computed from the frame color brightness and the frame color.
[const] int fill_brightness( bool real )Description: Get the fill brightness value If the brightness is not set, this method may return an invalid value
fill_brightness=( int brightness )Description: Set the fill brightness For neutral brightness set this value to 0. For darker colors set it to a negative value (down to -255), for brighter colors to a positive value (up to 255)
[const] unsigned int fill_color( bool real )Description: Get the fill color This method may return an invalid color if the color is not set.
fill_color=( unsigned int color )Description: Set the fill color to the given value The color is a 32bit value encoding the blue value in the lower 8 bits, the green value in the next 8 bits and the red value in the 8 bits above that.
[const] LayerPropertiesNode flatDescription: return the "flattened" object Contrary to what the name suggests, this method does not flatten the hierarchy but rather returns an object that does not need a parent for the "real" properties. See LayerProperties::flat for a description of this process. The child list of the returned object will be the same that of the original object.
[const] int frame_brightness( bool real )Description: Get the frame brightness value If the brightness is not set, this method may return an invalid value
frame_brightness=( int brightness )Description: Set the frame brightness For neutral brightness set this value to 0. For darker colors set it to a negative value (down to -255), for brighter colors to a positive value (up to 255)
[const] unsigned int frame_color( bool real )Description: Get the frame color This method may return an invalid color if the color is not set.
frame_color=( unsigned int color )Description: Set the frame color to the given value The color is a 32bit value encoding the blue value in the lower 8 bits, the green value in the next 8 bits and the red value in the 8 bits above that.
[const] bool has_children?Description: Test, if there are children
[const] bool has_dither_pattern?( bool )Description: Test, if the dither pattern is set
[const] bool has_fill_color?( bool )Description: Test, if the frame color is set
[const] bool has_frame_color?( bool )Description: Test, if the frame color is set
[const] bool has_lower_hier_level?( bool real )Description: True, if a lower hierarchy level is explicitly specified If "real" is true, the effective value is returned.
[const] bool has_source_name( bool real )Description: Tell, if a stream layer name is specified for this layer If "real" is true, the effective value is returned.
[const] bool has_upper_hier_level?( bool real )Description: True, if a upper hierarchy level is explicitly specified If "real" is true, the effective value is returned.
[const] unsigned int idDescription: Obtain the unique ID Each layer properties node object has a unique ID that is created when a new LayerPropertiesNode object is instantiated. The ID is copied when the object is copied. The ID can be used to identify the object irregardless of it's content.
[const] int layer_indexDescription: Access to the the layer index This is the index of the actual layer used. The source specification given by source_layer, source_datatype, source_name is evaluated and the corresponding layer is looked up in the layout object. If a source_layer_index is specified, this layer index is taken as the layer index to use.
[const] int lower_hier_level( bool real )Description: The lower hierarchy level shown This is the hierarchly level at which the drawing starts. This property is only meaningful, if has_lower_hier_level? is true.
lower_hier_level=( int level )Description: Specify a lower hierarchy level If this method is called, the lower hierarchy level is enabled. See lower_hier_level for a description of this property
marked=( bool marked )Description: Set the marked state
[const] bool marked?( bool )Description: Get the marked state
[const] string nameDescription: Get the name
name=( string name )Description: Set the name to the given string
[const] string source( bool real )Description: The source specification This method delivers the source specification as a string
source=( string s )Description: Load the source specification from a string Sets the source specification to the given string. The source specification may contain the cellview index, the source layer (given by layer/datatype or layer name), transformation, property selector etc. This method throws an exception if the specification is not valid.
[const] int source_cellview( bool real )Description: Get the cellview index that this layer refers to If "real" is true, the effective value is returned.
source_cellview=( int cellview_index )Description: Set the cellview index that this layer refers to See cellview for a description of the transformations.
[const] int source_datatype( bool real )Description: Get the stream datatype that the shapes are taken from If the datatype is positive, the actual layer is looked up by this stream datatype. If a name or layer index is specified, the stream datatype is not used. If "real" is true, the effective value is returned.
source_datatype=( int datatype )Description: Set the stream datatype that the shapes are taken from See datatype for a description of this property
[const] int source_layer( bool real )Description: Get the stream layer that the shapes are taken from If the layer is positive, the actual layer is looked up by this stream layer. If a name or layer index is specified, the stream layer is not used. If "real" is true, the effective value is returned.
source_layer=( int layer )Description: Set the stream layer that the shapes are taken from See source_layer for a description of this property
[const] int source_layer_index( bool real )Description: Get the layer index that the shapes are taken from If the layer index is positive, the shapes drawn are taken from this layer rather than searched for by layer and datatype. This property is stronger than the layer/datatype or name specification. The similar method layer_index returns the actual layer index used, not the given one. The latter may be negative indicating that layer/datatype or name specifications are used. If "real" is true, the effective value is returned.
source_layer_index=( int index )Description: Set the layer index specification that the shapes are taken from See source_layer_index for a description of this property.
[const] string source_name( bool real )Description: Get the stream name that the shapes are taken from If the name is non-empty, the actual layer is looked up by this stream layer name. If a layer index (see layer_index) is specified, the stream datatype is not used. A name is only meaningful for OASIS files. If "real" is true, the effective value is returned.
source_name=( string name )Description: Set the stream layer name that the shapes are taken from See name for a description of this property
[const] CplxTrans[ ] trans( bool real )Description: Get the transformations that the layer is transformed with The transformations returned by this accessor is the one used for displaying this layer. The layout is transformed with each of these transformations before it is drawn. If "real" is true, the effective value is returned.
trans=( CplxTrans trans_vector[ ] )Description: Set the transformations that the layer is transformed with See trans for a description of the transformations.
transparent=( bool transparent )Description: Set the transparency state
[const] bool transparent?( bool )Description: Get the transparency state
[const] int upper_hier_level( bool real )Description: The upper hierarchy level shown This is the hierarchly level at which the drawing starts. This property is only meaningful, if has_upper_hier_level is true.
upper_hier_level=( int level )Description: Specify a upper hierarchy level If this method is called, the upper hierarchy level is enabled. See upper_hier_level for a description of this property
visible=( bool visible )Description: Set the visibility state
[const] bool visible?( bool )Description: Get the visibility state
[const] int width( bool )Description: Get the line width
width=( int width )Description: Set the line width to the given width
|