Skip To Content

ComputeEdgeAttributesSettings

Compute edge infos.

@example:
# Compute edge infos with custom settings for shape 'Block 1'
shapes = ce.getObjectsFrom(ce.scene, ce.isShape, ce.withName("'Block 1'"))
settings = ComputeEdgeAttributesSettings()
ce.computeEdgeAttributes(shapes, settings)

 

Methods defined here:

getAdjacencySearchAngleAbsolute

getAdjacencySearchAngleAbsolute(self):

Gets AdjacencySearchAngleAbsolute field. Angle for searching adjacent objects (0: perpendicular to edge, >0: towards outside from corners, <0: towards inside from corners).

@return: Value of AdjacencySearchAngleAbsolute field.  [float]

@example:
# Prints the default absolute adjacency search angle
settings = ComputeEdgeAttributesSettings()
print settings.getAdjacencySearchAngleAbsolute()

getAdjacencySearchRangeAbsolute

getAdjacencySearchRangeAbsolute(self):

Gets AdjacencySearchRangeAbsolute field. Absolute range for searching adjacent objects.

@return: Value of AdjacencySearchRangeAbsolute field.  [float]

@example:
# Prints the default absolute adjacency search range
settings = ComputeEdgeAttributesSettings()
print settings.getAdjacencySearchRangeAbsolute()

getAllowMultipleFrontEdges

getAllowMultipleFrontEdges(self):

Gets AllowMultipleFrontEdges field. Allow multipe edges with same adjacent street class to become front edges.

@return: Value of AllowMultipleFrontEdges field.  [True/False]

@example:
# Prints the default setting for multiple front edges
settings = ComputeEdgeAttributesSettings()
print settings.getAllowMultipleFrontEdges()

getCommaSeparatedListOfStreetClasses

getCommaSeparatedListOfStreetClasses(self):

Gets CommaSeparatedListOfStreetClasses field. Comma-separated ordered list of street classes. Leave empty to use built-in major/minor street class.

@return: Value of CommaSeparatedListOfStreetClasses field.  [str]

@example:
# Prints the default list of street classes
settings = ComputeEdgeAttributesSettings()
print settings.getCommaSeparatedListOfStreetClasses()

getEdgeIndentPercentageOfEdgeLength

getEdgeIndentPercentageOfEdgeLength(self):

Gets EdgeIndentPercentageOfEdgeLength field. Relative indent of both corners along edge (percentage, 100% equals edge mid-point).

@return: Value of EdgeIndentPercentageOfEdgeLength field.  [float]

@example:
# Prints the default indent percentage of the edge length
settings = ComputeEdgeAttributesSettings()
print settings.getEdgeIndentPercentageOfEdgeLength()

getEdgeToleranceAbsolute

getEdgeToleranceAbsolute(self):

Gets EdgeToleranceAbsolute field. Absolute offset towards inside of edge for increased tolerance of overlapping adjacent shapes.

@return: Value of EdgeToleranceAbsolute field.  [float]

@example:
# Prints the default absolute edge tolerance
settings = ComputeEdgeAttributesSettings()
print settings.getEdgeToleranceAbsolute()

getPrecedenceForFrontEdges

getPrecedenceForFrontEdges(self):

Gets PrecedenceForFrontEdges field. Precedence for Front Edges.

@return: Value of PrecedenceForFrontEdges field.  ["LONG_EDGE", "SHORT_EDGE"] [str]

@example:
# Prints the default precedence for front edges
settings = ComputeEdgeAttributesSettings()
print settings.getPrecedenceForFrontEdges()

getPrecedenceForRearEdges

getPrecedenceForRearEdges(self):

Gets PrecedenceForRearEdges field. Precedence for Rear Edges.

@return: Value of PrecedenceForRearEdges field.  ["FURTHEST_FROM_FRONT", "PARALLEL_TO_FRONT"] [str]

@example:
# Prints the default precedence for front edges
settings = ComputeEdgeAttributesSettings()
print settings.getPrecedenceForRearEdges()

getStreetClassAttribute

getStreetClassAttribute(self):

Gets StreetClassAttribute field. Street edge attribute to fetch the street class from. Leave empty to use built-in major/minor street class.

@return: Value of StreetClassAttribute field.  [str]

@example:
# Prints the default street class attribute
settings = ComputeEdgeAttributesSettings()
print settings.getStreetClassAttribute()

getStreetWidthAttribute

getStreetWidthAttribute(self):

Gets StreetWidthAttribute field. Street edge attribute to fetch the street width from. Leave empty to use built-in street width.

@return: Value of StreetWidthAttribute field.  [str]

@example:
# Prints the default street width attribute
settings = ComputeEdgeAttributesSettings()
print settings.getStreetWidthAttribute()

setAdjacencySearchAngleAbsolute

setAdjacencySearchAngleAbsolute(self, floatValue):

Sets AdjacencySearchAngleAbsolute field. Angle for searching adjacent objects (0: perpendicular to edge, >0: towards outside from corners, <0: towards inside from corners).

@param floatValue: the new value. [float]

@example:
# Sets the absolute adjacency search angle to 30 degrees
settings = ComputeEdgeAttributesSettings()
settings.setAdjacencySearchRangeAbsolute(30.0)

setAdjacencySearchRangeAbsolute

setAdjacencySearchRangeAbsolute(self, floatValue):

Sets AdjacencySearchRangeAbsolute field. Absolute range for searching adjacent objects.

@param floatValue: the new value. [float]

@example:
# Sets the absolute adjacency search range to 10
settings = ComputeEdgeAttributesSettings()
settings.setAdjacencySearchRangeAbsolute(10.0)

setAllowMultipleFrontEdges

setAllowMultipleFrontEdges(self, booleanValue):

Sets AllowMultipleFrontEdges field. Allow multipe edges with same adjacent street class to become front edges.

@param booleanValue: the new value. [True/False]

@example:
# Sets multiple front edges as enabled
settings = ComputeEdgeAttributesSettings()
settings.setAllowMultipleFrontEdges(True)

setCommaSeparatedListOfStreetClasses

setCommaSeparatedListOfStreetClasses(self, stringValue):

Sets CommaSeparatedListOfStreetClasses field. Comma-separated ordered list of street classes. Leave empty to use built-in major/minor street class.

@param stringValue: the new value. [str]

@example:
# Sets list of street classes
settings = ComputeEdgeAttributesSettings()
settings.setCommaSeparatedListOfStreetClasses("Major, Minor")

setEdgeIndentPercentageOfEdgeLength

setEdgeIndentPercentageOfEdgeLength(self, floatValue):

Sets EdgeIndentPercentageOfEdgeLength field. Relative indent of both corners along edge (percentage, 100% equals edge mid-point).

@param floatValue: the new value. [float]

@example:
# Sets the indent percentage of the edge length to 15
settings = ComputeEdgeAttributesSettings()
settings.setEdgeIndentPercentageOfEdgeLength(15.0)

setEdgeToleranceAbsolute

setEdgeToleranceAbsolute(self, floatValue):

Sets EdgeToleranceAbsolute field. Absolute offset towards inside of edge for increased tolerance of overlapping adjacent shapes.

@param floatValue: the new value. [float]

@example:
# Sets the absolute edge tolerance to 0.1
settings = ComputeEdgeAttributesSettings()
settings.setEdgeToleranceAbsolute(0.1)

setPrecedenceForFrontEdges

setPrecedenceForFrontEdges(self, enumValue):

Sets PrecedenceForFrontEdges field. Precedence for Front Edges.

@param enumValue: the new value ["LONG_EDGE", "SHORT_EDGE"]. [str]

@example:
# Sets the precedence for front edges to Long Edge
settings = ComputeEdgeAttributesSettings()
settings.setPrecedenceForFrontEdges(ComputeEdgeAttributesSettings.LONG_EDGE)

setPrecedenceForRearEdges

setPrecedenceForRearEdges(self, enumValue):

Sets PrecedenceForRearEdges field. Precedence for Rear Edges.

@param enumValue: the new value ["FURTHEST_FROM_FRONT", "PARALLEL_TO_FRONT"]. [str]

@example:
# Sets the precedence for front edges to Parallel to Front Edge
settings = ComputeEdgeAttributesSettings()
settings.setPrecedenceForRearEdges(ComputeEdgeAttributesSettings.PARALLEL_TO_FRONT)

setStreetClassAttribute

setStreetClassAttribute(self, stringValue):

Sets StreetClassAttribute field. Street edge attribute to fetch the street class from. Leave empty to use built-in major/minor street class.

@param stringValue: the new value. [str]

@example:
# Sets the street class attribute to Major
settings = ComputeEdgeAttributesSettings()
settings.setStreetClassAttribute("Major")

setStreetWidthAttribute

setStreetWidthAttribute(self, stringValue):

Sets StreetWidthAttribute field. Street edge attribute to fetch the street width from. Leave empty to use built-in street width.

@param stringValue: the new value. [str]

@example:
# Sets the street width attribute to street_width
settings = ComputeEdgeAttributesSettings()
settings.setStreetWidthAttribute("street_width")

Constants

This class defines the following constants:

FURTHEST_FROM_FRONT = 'FURTHEST_FROM_FRONT'
LONG_EDGE = 'LONG_EDGE'
PARALLEL_TO_FRONT = 'PARALLEL_TO_FRONT'
SHORT_EDGE = 'SHORT_EDGE'