Notation used in Ruby API documentation
Module: lay
Description: A class representing a reference to a layer properties node
Class hierarchy: LayerPropertiesNodeRef » LayerPropertiesNode » LayerProperties
This object is returned by the layer properties iterator's current method (LayerPropertiesIterator#current). A reference behaves like a layer properties node, but changes in the node are reflected in the view it is attached to.
A typical use case for references is this:
# Hides a layers of a view view = RBA::LayoutView::current view.each_layer do |lref| # lref is a LayerPropertiesNodeRef object lref.visible = false end
This class has been introduced in version 0.25.
| void | _assign | (const LayerPropertiesNodeRef other) | Assigns another object to self | |
| [const] | LayerPropertiesNodeRef ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | new LayerPropertiesNodeRef ptr | _dup | Creates a copy of self | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | assign | (const LayerPropertiesNode other) | Assigns the contents of the 'other' object to self. | |
| void | assign | (const LayerProperties other) | Assigns the contents of the 'other' object to self. | |
| void | delete | Erases the current node and all child nodes | ||
| [const] | LayerPropertiesNode | dup | Creates a LayerPropertiesNode object as a copy of the content of this node. | |
| [const] | bool | is_valid? | Returns true, if the reference points to a valid layer properties node |
_assign | Signature: void _assign (const LayerPropertiesNodeRef other) Description: Assigns another object to self |
_const_cast | Signature: [const] LayerPropertiesNodeRef ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. |
_create | Signature: void _create Description: 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. |
_destroy | Signature: void _destroy Description: 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. |
_destroyed? | Signature: [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. |
_dup | Signature: [const] new LayerPropertiesNodeRef ptr _dup Description: Creates a copy of self |
_is_const_object? | Signature: [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. |
_manage | Signature: void _manage Description: 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. |
_unmanage | Signature: void _unmanage Description: 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. |
assign | (1) Signature: void assign (const LayerPropertiesNode other) Description: Assigns the contents of the 'other' object to self. This version accepts a LayerPropertiesNode object and allows modification of the layer node's hierarchy. Assignment will reconfigure the layer node in the view. |
(2) Signature: void assign (const LayerProperties other) Description: Assigns the contents of the 'other' object to self. This version accepts a LayerProperties object. Assignment will change the properties of the layer in the view. | |
delete | Signature: void delete Description: Erases the current node and all child nodes After erasing the node, the reference will become invalid. |
dup | Signature: [const] LayerPropertiesNode dup Description: Creates a LayerPropertiesNode object as a copy of the content of this node. This method is mainly provided for backward compatibility with 0.24 and before. Python specific notes: |
is_valid? | Signature: [const] bool is_valid? Description: Returns true, if the reference points to a valid layer properties node Invalid references behave like ordinary LayerPropertiesNode objects but without the ability to update the view upon changes of attributes. |