Skip To Content

AlignTerrainSettings

The settings for the alignTerrain command.

@example:
# The settings giving additional control over the behaviour of alignTerrain
atSettings = AlignTerrainSettings()
atSettings.setLowerTerrain(True)
atSettings.setRaiseTerrain(True)
atSettings.setMaxRaiseDist(1000)
atSettings.setMaxLowerDist(1000)
atSettings.setBorder(True)
#Write cut/fill volumes to attributes
atSettings.setWriteCutFill(True)
# If no layers are selected, apply to all terrain layers
layer = ce.getObjectsFrom(ce.scene, ce.isLayer, ce.withName("'Streetnetwork'" ))[0]
ce.alignTerrain( ce.getObjectsFrom(layer, ce.isShape ), atSettings )

 

Methods defined here:

getBorder

getBorder(self):

Gets Border field. If enabled, a small border region around the shapes is aligned, too.

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

getLowerTerrain

getLowerTerrain(self):

Gets LowerTerrain field.

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

getMaxLowerDist

getMaxLowerDist(self):

Gets MaxLowerDist field. If distance between terrain and shape is smaller, terrain vertices above shape are lowered.

@return: Value of MaxLowerDist field.  [float]

getMaxRaiseDist

getMaxRaiseDist(self):

Gets MaxRaiseDist field. If distance between terrain and shape is smaller, terrain vertices below shape are raised.

@return: Value of MaxRaiseDist field.  [float]

getRaiseTerrain

getRaiseTerrain(self):

Gets RaiseTerrain field.

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

getTerrain

getTerrain(self):

Gets Terrain field.

@return: Value of Terrain field.  [str]

getWriteCutFill

getWriteCutFill(self):

Gets WriteCutFill field. If enabled, for each selected shape cut/fill volumes are approximately calculated. The values are written into the object attributes (fields "cutVolume" and "fillVolume").

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

setBorder

setBorder(self, booleanValue):

Sets Border field. If enabled, a small border region around the shapes is aligned, too.

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

setLowerTerrain

setLowerTerrain(self, booleanValue):

Sets LowerTerrain field. If enabled, terrain vertices above selected shapes are aligned.

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

setMaxLowerDist

setMaxLowerDist(self, floatValue):

Sets MaxLowerDist field. If distance between terrain and shape is smaller, terrain vertices above shape are lowered.

@param floatValue: the new value. [float]

setMaxRaiseDist

setMaxRaiseDist(self, floatValue):

Sets MaxRaiseDist field. If distance between terrain and shape is smaller, terrain vertices below shape are raised.

@param floatValue: the new value. [float]

setRaiseTerrain

setRaiseTerrain(self, booleanValue):

Sets RaiseTerrain field. If enabled, terrain vertices below selected shapes are aligned.

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

setTerrain

setTerrain(self, stringValue):

Sets Terrain field.

@param stringValue: the new value. [str]

setWriteCutFill

setWriteCutFill(self, booleanValue):

Sets WriteCutFill field. If enabled, for each selected shape cut/fill volumes are approximately calculated. The values are written into the object attributes (fields "cutVolume" and "fillVolume").

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