Skip To Content

ResetTerrainSettings

The settings for the resetTerrain command.

@example:
# optional settings giving additional control over the behaviour of resetTerrain
se = ResetTerrainSettings()
# add a small border ot the selected shapes
se.setAddBorder(True)
# call reset terrain with the current selection and new options
shapes = ce.getObjectsFrom(ce.scene, ce.isShape)
ce.resetTerrain(shapes,se)

 

Methods defined here:

getAddBorder

getAddBorder(self):

Gets AddBorder field. If enabled, a small border region around the shapes is reset, too.

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

getConstraint

getConstraint(self):

Gets Constraint field.

@return: Value of Constraint field.  ["EVERYWHERE", "SELECTION"] [str]

getTerrain

getTerrain(self):

Gets Terrain field.

@return: Value of Terrain field.  [str]

setAddBorder

setAddBorder(self, booleanValue):

Sets AddBorder field. If enabled, a small border region around the shapes is reset, too.

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

setConstraint

setConstraint(self, enumValue):

Sets Constraint field.

@param enumValue: the new value ["EVERYWHERE", "SELECTION"]. [str]

setTerrain

setTerrain(self, stringValue):

Sets Terrain field.

@param stringValue: the new value. [str]

Constants

This class defines the following constants:

EVERYWHERE = 'EVERYWHERE'
SELECTION = 'SELECTION'