Notation used in Ruby API documentation
Module: db
Description: This class represents the cell variant type for various methods.
Cell variants are needed in hierarchical applications, when operations are to be performed on cell level, but the operations are not transformation invariant. In that case, a variant type needs to be specified in order to make the algorithm separate the cells by their absolute orientation or by their accumulated magnification.
This enum has been introduced in version 0.30.2.
| new VariantType ptr | new | (int i) | Creates an enum from an integer value |
| new VariantType ptr | new | (string s) | Creates an enum from a string value |
| [const] | bool | != | (const VariantType other) | Compares two enums for inequality |
| [const] | bool | != | (int other) | Compares an enum with an integer for inequality |
| [const] | bool | < | (const VariantType other) | Returns true if the first enum is less (in the enum symbol order) than the second |
| [const] | bool | < | (int other) | Returns true if the enum is less (in the enum symbol order) than the integer value |
| [const] | bool | == | (const VariantType other) | Compares two enums |
| [const] | bool | == | (int other) | Compares an enum with an integer value |
| [const] | VariantType 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] | 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 VariantType other) | Assigns another object to self | |
| [const] | new VariantType ptr | dup | Creates a copy of self | |
| [const] | int | hash | Gets the hash value from the enum | |
| [const] | string | inspect | Converts an enum to a visual string | |
| [const] | int | to_i | Gets the integer value from the enum | |
| [const] | string | to_s | Gets the symbolic string from an enum |
| [static,const] | VariantType | Magnification | Scaling variants needed. | |
| [static,const] | VariantType | MagnificationAndOrientation | Scaling and orientation variants needed. | |
| [static,const] | VariantType | NoVariants | No variants needed. | |
| [static,const] | VariantType | Orientation | Orientation variants needed. | |
| [static,const] | VariantType | Orthogonal | Orthogonal transformations (rotations by multiples of 90 degree) need variants. | |
| [static,const] | VariantType | XYAnisotropyAndMagnification | Scaling and anisotropy variants needed. |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
!= | (1) Signature: [const] bool != (const VariantType other) Description: Compares two enums for inequality |
(2) Signature: [const] bool != (int other) Description: Compares an enum with an integer for inequality | |
< | (1) Signature: [const] bool < (const VariantType other) Description: Returns true if the first enum is less (in the enum symbol order) than the second |
(2) Signature: [const] bool < (int other) Description: Returns true if the enum is less (in the enum symbol order) than the integer value | |
== | (1) Signature: [const] bool == (const VariantType other) Description: Compares two enums |
(2) Signature: [const] bool == (int other) Description: Compares an enum with an integer value | |
Magnification | Signature: [static,const] VariantType Magnification Description: Scaling variants needed. For example, distance measurements or the isotropic sizing operations needs this variant type. Python specific notes: |
MagnificationAndOrientation | Signature: [static,const] VariantType MagnificationAndOrientation Description: Scaling and orientation variants needed. For example, the 'move' operation needs this variant type. Python specific notes: |
NoVariants | Signature: [static,const] VariantType NoVariants Description: No variants needed. Python specific notes: |
Orientation | Signature: [static,const] VariantType Orientation Description: Orientation variants needed. For example, the edge orientation selection operation needs this variant type. Python specific notes: |
Orthogonal | Signature: [static,const] VariantType Orthogonal Description: Orthogonal transformations (rotations by multiples of 90 degree) need variants. For example, the diagonal edge selection operation needs this variant type. Python specific notes: |
XYAnisotropyAndMagnification | Signature: [static,const] VariantType XYAnisotropyAndMagnification Description: Scaling and anisotropy variants needed. For example, the anisotropic sizing operation needs this variant type. Python specific notes: |
_const_cast | Signature: [const] VariantType 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. |
_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 | Signature: void assign (const VariantType other) Description: Assigns another object to self |
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead 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 Use of this method is deprecated. Use _destroy instead 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 Use of this method is deprecated. Use _destroyed? instead 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 VariantType ptr dup Description: Creates a copy of self Python specific notes: |
hash | Signature: [const] int hash Description: Gets the hash value from the enum Python specific notes: |
inspect | Signature: [const] string inspect Description: Converts an enum to a visual string Python specific notes: |
is_const_object? | Signature: [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 This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
new | (1) Signature: [static] new VariantType ptr new (int i) Description: Creates an enum from an integer value Python specific notes: |
(2) Signature: [static] new VariantType ptr new (string s) Description: Creates an enum from a string value Python specific notes: | |
to_i | Signature: [const] int to_i Description: Gets the integer value from the enum Python specific notes: |
to_s | Signature: [const] string to_s Description: Gets the symbolic string from an enum Python specific notes: |