Skip To Content

AlignShapeSettings

Shape align settings.

@example:
# Settings class used to control parameters for alignShape operation
lotLayer = ce.getObjectsFrom(ce.scene, ce.isLayer, ce.withName("'Lots'"))
settings = AlignShapesSettings()
settings.setHeightmap('Heightmap')
settings.setAlignFunction('TRANSLATE_TO_MIN')
ce.alignShapes(lotLayer, settings)

 

Methods defined here:

getAlignFunction

getAlignFunction(self):

Gets AlignFunction field. Specifies the alignment function.

@return: Value of AlignFunction field.  ["PROJECT_ALL", "PROJECT_BELOW", "PROJECT_TO_OBJ_AVG", "TRANSLATE_TO_AVG", "TRANSLATE_TO_MAX", "TRANSLATE_TO_MIN"] [str]

getHeightmap

getHeightmap(self):

Gets Heightmap field. Specifies the heightmap to align to. Use "y = 0" for alignment to X-Z plane.

@return: Value of Heightmap field.  [str]

getOffset

getOffset(self):

Gets Offset field. Y-Offset to be added to the aligned vertices.

@return: Value of Offset field.  [float]

setAlignFunction

setAlignFunction(self, enumValue):

Sets AlignFunction field. Specifies the alignment function.

@param enumValue: the new value ["PROJECT_ALL", "PROJECT_BELOW", "PROJECT_TO_OBJ_AVG", "TRANSLATE_TO_AVG", "TRANSLATE_TO_MAX", "TRANSLATE_TO_MIN"]. [str]

setHeightmap

setHeightmap(self, stringValue):

Sets Heightmap field. Specifies the heightmap to align to. Use "y = 0" for alignment to X-Z plane.

@param stringValue: the new value. [str]

setOffset

setOffset(self, floatValue):

Sets Offset field. Y-Offset to be added to the aligned vertices.

@param floatValue: the new value. [float]

Constants

This class defines the following constants:

PROJECT_ALL = 'PROJECT_ALL'
PROJECT_BELOW = 'PROJECT_BELOW'
PROJECT_TO_OBJ_AVG = 'PROJECT_TO_OBJ_AVG'
TRANSLATE_TO_AVG = 'TRANSLATE_TO_AVG'
TRANSLATE_TO_MAX = 'TRANSLATE_TO_MAX'
TRANSLATE_TO_MIN = 'TRANSLATE_TO_MIN'