ModelerDisplayOptions

class ModelerDisplayOptions(model_id: str, client: Client)

Bases: object

Examples: Code Snippet: Modeler Display Options

Modeler display options: general, colors, boundary visibility, drawing, ruler, and ponded water style. Color fields are int32 in the API (Windows COLORREF values, typically 0x00BBGGRR).

getProperties() → ModelerDisplayOptionsProperties

setProperties(props: ModelerDisplayOptionsProperties) → None

getShowCoordinatesOfLastVertex() → bool

setShowCoordinatesOfLastVertex(value: bool) → None

getShowSegmentLengthRadiusAngles() → bool

setShowSegmentLengthRadiusAngles(value: bool) → None

getShowSegmentLengthRadiusRatio() → bool

setShowSegmentLengthRadiusRatio(value: bool) → None

getShowGridPointsOnSearchGrid() → bool

setShowGridPointsOnSearchGrid(value: bool) → None

getMaterialBoundaryColour() → int

setMaterialBoundaryColour(value: int) → None

getExternalBoundaryColour() → int

setExternalBoundaryColour(value: int) → None

getProfileColour() → int

setProfileColour(value: int) → None

getTensionCrackColour() → int

setTensionCrackColour(value: int) → None

getPiezoLineColour() → int

setPiezoLineColour(value: int) → None

getWaterTableColour() → int

setWaterTableColour(value: int) → None

getAnisotropicSurfaceColour() → int

setAnisotropicSurfaceColour(value: int) → None

get3DAnisotropicSurfaceColour() → int

set3DAnisotropicSurfaceColour(value: int) → None

getWeakLayerColour() → int

setWeakLayerColour(value: int) → None

getDamageRegionColour() → int

setDamageRegionColour(value: int) → None

getElementsColour() → int

setElementsColour(value: int) → None

getShowMaterialBoundaries() → bool

setShowMaterialBoundaries(value: bool) → None

getShowProfiles() → bool

setShowProfiles(value: bool) → None

getShowExternalBoundary() → bool

setShowExternalBoundary(value: bool) → None

getShowTensionCracks() → bool

setShowTensionCracks(value: bool) → None

getShowWaterTables() → bool

setShowWaterTables(value: bool) → None

getShowPiezoLines() → bool

setShowPiezoLines(value: bool) → None

getShowWeakLayers() → bool

setShowWeakLayers(value: bool) → None

getShowAnisotropicSurfaces() → bool

setShowAnisotropicSurfaces(value: bool) → None

getShow3DAnisotropicSurfaces() → bool

setShow3DAnisotropicSurfaces(value: bool) → None

getShowDamageRegions() → bool

setShowDamageRegions(value: bool) → None

getShowSupportFacePlates() → bool

setShowSupportFacePlates(value: bool) → None

getShowBoreholes() → bool

setShowBoreholes(value: bool) → None

getDrawWeakLayerByMaterial() → bool

setDrawWeakLayerByMaterial(value: bool) → None

getShowBoundaryVertices() → bool

setShowBoundaryVertices(value: bool) → None

getShowDamageRegionsHatch() → bool

setShowDamageRegionsHatch(value: bool) → None

getLineWidth() → int

setLineWidth(value: int) → None

getLoadScalingDisplayFactor() → float

setLoadScalingDisplayFactor(value: float) → None

getScaleDisplayItemsOnZoom() → bool

setScaleDisplayItemsOnZoom(value: bool) → None

getShowDiscretizations() → bool

setShowDiscretizations(value: bool) → None

getDrawMidsideNodes() → bool

setDrawMidsideNodes(value: bool) → None

getShowNodeNumbers() → bool

setShowNodeNumbers(value: bool) → None

getShowElementNumbers() → bool

setShowElementNumbers(value: bool) → None

getShowBoundaryConditions() → bool

setShowBoundaryConditions(value: bool) → None

getShowBoundaryConditionValues() → bool

setShowBoundaryConditionValues(value: bool) → None

getShowElements() → bool

setShowElements(value: bool) → None

getShowPondedWater() → bool

setShowPondedWater(value: bool) → None

getShowWaterPressureGrid() → bool

setShowWaterPressureGrid(value: bool) → None

getShowWaterPressureGridValues() → bool

setShowWaterPressureGridValues(value: bool) → None

getShowDiscreteStrengthGridValues() → bool

setShowDiscreteStrengthGridValues(value: bool) → None

getShowDiscreteStrengthSymbols() → bool

setShowDiscreteStrengthSymbols(value: bool) → None

getUseDiscreteStrengthTransparentTextBackground() → bool

setUseDiscreteStrengthTransparentTextBackground(value: bool) → None

getShowSoilProfile() → bool

setShowSoilProfile(value: bool) → None

getShowRuler() → bool

setShowRuler(value: bool) → None

getUseBlackWhiteRulerBackground() → bool

setUseBlackWhiteRulerBackground(value: bool) → None

getUsePondedWaterFill() → bool

setUsePondedWaterFill(value: bool) → None

getUsePondedWaterHatch() → bool

setUsePondedWaterHatch(value: bool) → None

getPondedWaterHatchStyle() → DisplayHatchStyle

setPondedWaterHatchStyle(value: DisplayHatchStyle) → None

getPondedWaterLineColour() → int

setPondedWaterLineColour(value: int) → None

getPondedWaterFillColour() → int

setPondedWaterFillColour(value: int) → None