API reference - Class LayerPropertiesNodeNotation used in Ruby API documentation Description: A layer properties node structure Class hierarchy: LayerPropertiesNode » LayerProperties 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. Public constructors
Public methods
Detailed description[const] bool !=(const LayerPropertiesNode other)Description: Inequality
[const] bool ==(const LayerPropertiesNode other)Description: Equality
LayerPropertiesNode ptr add_child(const LayerProperties child)Description: Add a child entry
This method allows to build a layer properties tree by adding children to node objects. It returns a reference to the node object created. This method was introduced in version 0.22. [const] void assign(const 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. void clear_childrenDescription: Clears all children This method was introduced in version 0.22. void 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 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: 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] LayerPropertiesNode dupDescription: Creates a copy of self [const] LayerPropertiesNode flatDescription: return the "flattened" (effective) layer properties node for this node This method returns a LayerPropertiesNode object that is not embedded into a hierarchy. This object represents the effective layer properties for the given node. In particular, all 'local' properties are identical to the 'real' properties. Such an object can be used as a basis for manipulations. Unlike the name suggests, this node will still contain a hierarchy of nodes below if the original node did so. [const] bool has_children?Description: Test, if there are children [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] 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. [static] LayerPropertiesNode newDescription: Creates a new object of this class |