Notation used in Ruby API documentation
Module: db
Description: A Path object with properties attached.
Class hierarchy: PathWithProperties » Path
This class represents a combination of a Path object an user properties. User properties are stored in form of a properties ID. Convenience methods are provided to manipulate or retrieve user properties directly.
This class has been introduced in version 0.30.
| new PathWithProperties ptr | new | (const Path path, unsigned long properties_id = 0) | Creates a new object from a property-less object and a properties ID. |
| new PathWithProperties ptr | new | (const Path path, map<variant,variant> properties) | Creates a new object from a property-less object and a properties hash. |
| [const] | DPathWithProperties | * | (double f) | Scales the object by some factor |
| void | _assign | (const PathWithProperties other) | Assigns another object to self | |
| [const] | PathWithProperties 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 PathWithProperties 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 | delete_property | (variant key) | Deletes the user property with the given key | |
| [const] | Path | downcast | Gets the corresponding object without the properties | |
| PathWithProperties | move | (const Vector v) | Moves the object. | |
| PathWithProperties | move | (int dx = 0, int dy = 0) | Moves the object. | |
| [const] | PathWithProperties | moved | (const Vector v) | Returns the moved object |
| [const] | PathWithProperties | moved | (int dx = 0, int dy = 0) | Returns the moved object (does not modify self) |
| [const] | unsigned long | prop_id | Gets the properties ID associated with the object | |
| void | prop_id= | (unsigned long id) | Sets the properties ID of the object | |
| [const] | variant | properties | Gets the user properties | |
| [const] | variant | property | (variant key) | Gets the user property with the given key |
| void | set_property | (variant key, variant value) | Sets the user property with the given key to the given value | |
| [const] | string | to_s | Returns a string representing the polygon | |
| void | transform | (const Trans t) | Transforms the object (in-place version) | |
| void | transform | (const ICplxTrans t) | Transforms the object (in-place version) | |
| [const] | PathWithProperties | transformed | (const Trans t) | Returns the transformed object |
| [const] | DPathWithProperties | transformed | (const CplxTrans t) | Returns the transformed object |
| [const] | PathWithProperties | transformed | (const ICplxTrans t) | Returns the transformed object |
* | Signature: [const] DPathWithProperties * (double f) Description: Scales the object by some factor Returns the scaled object. All coordinates are multiplied with the given factor and, if necessary, rounded. Python specific notes: | |||||
_assign | Signature: void _assign (const PathWithProperties other) Description: Assigns another object to self | |||||
_const_cast | Signature: [const] PathWithProperties 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 PathWithProperties 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. | |||||
delete_property | Signature: void delete_property (variant key) Description: Deletes the user property with the given key This method is a convenience method that deletes the property with the given key. It does nothing if no property with that key exists. Using that method is more convenient than creating a new property set with a new ID and assigning that properties ID. This method may change the properties ID. | |||||
downcast | Signature: [const] Path downcast Description: Gets the corresponding object without the properties | |||||
move | (1) Signature: PathWithProperties move (const Vector v) Description: Moves the object.
Moves the object by the given offset and returns the moved object. The object is overwritten. | |||||
(2) Signature: PathWithProperties move (int dx = 0, int dy = 0) Description: Moves the object.
Moves the object by the given offset and returns the moved object. The object is overwritten. | ||||||
moved | (1) Signature: [const] PathWithProperties moved (const Vector v) Description: Returns the moved object
Moves the object by the given offset and returns the moved object. The object is not modified. | |||||
(2) Signature: [const] PathWithProperties moved (int dx = 0, int dy = 0) Description: Returns the moved object (does not modify self)
Moves the object by the given offset and returns the moved object. The object is not modified. | ||||||
new | (1) Signature: [static] new PathWithProperties ptr new (const Path path, unsigned long properties_id = 0) Description: Creates a new object from a property-less object and a properties ID. Python specific notes: | |||||
(2) Signature: [static] new PathWithProperties ptr new (const Path path, map<variant,variant> properties) Description: Creates a new object from a property-less object and a properties hash. Python specific notes: | ||||||
prop_id | Signature: [const] unsigned long prop_id Description: Gets the properties ID associated with the object Python specific notes: | |||||
prop_id= | Signature: void prop_id= (unsigned long id) Description: Sets the properties ID of the object Python specific notes: | |||||
properties | Signature: [const] variant properties Description: Gets the user properties This method is a convenience method that gets the properties of the shape as a single hash. | |||||
property | Signature: [const] variant property (variant key) Description: Gets the user property with the given key This method is a convenience method that gets the user property with the given key. If no property with that key does not exist, it will return nil. Using that method is more convenient than using the layout object and the properties ID to retrieve the property value. | |||||
set_property | Signature: void set_property (variant key, variant value) Description: Sets the user property with the given key to the given value This method is a convenience method that sets the user property with the given key to the given value. If no property with that key exists, it will create one. Using that method is more convenient than creating a new property set with a new ID and assigning that properties ID. This method may change the properties ID. Note: GDS only supports integer keys. OASIS supports numeric and string keys. | |||||
to_s | Signature: [const] string to_s Description: Returns a string representing the polygon Python specific notes: | |||||
transform | (1) Signature: void transform (const Trans t) Description: Transforms the object (in-place version) | |||||
(2) Signature: void transform (const ICplxTrans t) Description: Transforms the object (in-place version) | ||||||
transformed | (1) Signature: [const] PathWithProperties transformed (const Trans t) Description: Returns the transformed object Returns a copy of the object, transformed by the given transformation. The result is equivalent to 'tr * self'. | |||||
(2) Signature: [const] DPathWithProperties transformed (const CplxTrans t) Description: Returns the transformed object Returns a copy of the object, transformed by the given transformation. The result is equivalent to 'tr * self'. | ||||||
(3) Signature: [const] PathWithProperties transformed (const ICplxTrans t) Description: Returns the transformed object Returns a copy of the object, transformed by the given transformation. The result is equivalent to 'tr * self'. |