API reference - Class Edges::EdgeType

Notation used in Ruby API documentation

Module: db

Description: This enum specifies the edge type for edge angle filters.

This class is equivalent to the class Edges::EdgeType

This enum was introduced in version 0.28.

Public constructors

new Edges::EdgeType ptrnew(int i)Creates an enum from an integer value
new Edges::EdgeType ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const Edges::EdgeType other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const Edges::EdgeType 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 Edges::EdgeType other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum

Public static methods and constants

[static,const]Edges::EdgeTypeDiagonalEdgesDiagonal edges are selected (-45 and 45 degree)
[static,const]Edges::EdgeTypeOrthoDiagonalEdgesDiagonal or orthogonal edges are selected (0, 90, -45 and 45 degree)
[static,const]Edges::EdgeTypeOrthoEdgesHorizontal and vertical edges are selected

Detailed description

!=

(1) Signature: [const] bool != (const Edges::EdgeType 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 Edges::EdgeType 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 Edges::EdgeType other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

DiagonalEdges

Signature: [static,const] Edges::EdgeType DiagonalEdges

Description: Diagonal edges are selected (-45 and 45 degree)

Python specific notes:
The object exposes a readable attribute 'DiagonalEdges'. This is the getter.

OrthoDiagonalEdges

Signature: [static,const] Edges::EdgeType OrthoDiagonalEdges

Description: Diagonal or orthogonal edges are selected (0, 90, -45 and 45 degree)

Python specific notes:
The object exposes a readable attribute 'OrthoDiagonalEdges'. This is the getter.

OrthoEdges

Signature: [static,const] Edges::EdgeType OrthoEdges

Description: Horizontal and vertical edges are selected

Python specific notes:
The object exposes a readable attribute 'OrthoEdges'. This is the getter.

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

Python specific notes:
This method is also available as 'repr(object)'.

new

(1) Signature: [static] new Edges::EdgeType ptr new (int i)

Description: Creates an enum from an integer value

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new Edges::EdgeType ptr new (string s)

Description: Creates an enum from a string value

Python specific notes:
This method is the default initializer of the object.

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

Python specific notes:
This method is also available as 'str(object)'.