InterpretDisplayOptions

class DisplayHatchStyle(*values)

Bases: Enum

Horizontal = 0

Vertical = 1

ForwardDiagonal = 2

BackwardDiagonal = 3

Cross = 4

DiagonalCross = 5

class InterpretDisplayOptions(model_id: str, client: Client)

Bases: object

Examples: Code Snippet: Interpret Display Options

Interpret 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() → InterpretDisplayOptionsProperties

setProperties(props: InterpretDisplayOptionsProperties) → None

getMaterialBoundaryColour() → int

setMaterialBoundaryColour(value: int) → None

getExternalBoundaryColour() → int

setExternalBoundaryColour(value: int) → None

getProfileBoundaryColour() → int

setProfileBoundaryColour(value: int) → None

getTensionCrackBoundaryColour() → int

setTensionCrackBoundaryColour(value: int) → None

getPiezoBoundaryColour() → int

setPiezoBoundaryColour(value: int) → None

getWaterTableBoundaryColour() → int

setWaterTableBoundaryColour(value: int) → None

getWaterTableFinalBoundaryColour() → int

setWaterTableFinalBoundaryColour(value: int) → None

getAnisoSurfaceBoundaryColour() → int

setAnisoSurfaceBoundaryColour(value: int) → None

getAnisoSurface3dBoundaryColour() → int

setAnisoSurface3dBoundaryColour(value: int) → None

getWeakLayerBoundaryColour() → int

setWeakLayerBoundaryColour(value: int) → None

getDamageRegionBoundaryColour() → int

setDamageRegionBoundaryColour(value: int) → None

getMeshElementsColour() → int

setMeshElementsColour(value: int) → None

getShowMaterialBoundaries() → bool

setShowMaterialBoundaries(value: bool) → None

getShowProfileBoundaries() → bool

setShowProfileBoundaries(value: bool) → None

getShowExternalBoundary() → bool

setShowExternalBoundary(value: bool) → None

getShowTensionCrack() → bool

setShowTensionCrack(value: bool) → None

getShowWaterTable() → bool

setShowWaterTable(value: bool) → None

getShowWaterTableFinal() → bool

setShowWaterTableFinal(value: bool) → None

getShowPiezoLines() → bool

setShowPiezoLines(value: bool) → None

getShowWeakLayers() → bool

setShowWeakLayers(value: bool) → None

getShowAnisotropicSurfaces() → bool

setShowAnisotropicSurfaces(value: bool) → None

getShowAnisotropicSurfaces3d() → bool

setShowAnisotropicSurfaces3d(value: bool) → None

getShowDamageRegions() → bool

setShowDamageRegions(value: bool) → None

getDrawWeakLayerByMaterial() → bool

setDrawWeakLayerByMaterial(value: bool) → None

getShowBoundaryVertices() → bool

setShowBoundaryVertices(value: bool) → None

getDrawDamageRegionsHatch() → bool

setDrawDamageRegionsHatch(value: bool) → None

getLineWidth() → int

setLineWidth(value: int) → None

getScaleDisplayItems() → bool

setScaleDisplayItems(value: bool) → None

getShowSoilProfile() → bool

setShowSoilProfile(value: bool) → None

getShowRuler() → bool

setShowRuler(value: bool) → None

getBlackWhiteRuler() → bool

setBlackWhiteRuler(value: bool) → None

getUsePondedWaterFill() → bool

setUsePondedWaterFill(value: bool) → None

getUsePondedWaterHatch() → bool

setUsePondedWaterHatch(value: bool) → None

getPondedWaterHatchStyle() → DisplayHatchStyle

setPondedWaterHatchStyle(value: DisplayHatchStyle) → None

getPondedWaterLineColor() → int

setPondedWaterLineColor(value: int) → None

getPondedWaterFillColor() → int

setPondedWaterFillColor(value: int) → None

getShowSliceBoundaries() → bool

setShowSliceBoundaries(value: bool) → None

getUseSliceFill() → bool

setUseSliceFill(value: bool) → None

getUseSliceHatch() → bool

setUseSliceHatch(value: bool) → None

getShowSliceNumbers() → bool

setShowSliceNumbers(value: bool) → None

getSliceFillColor() → int

setSliceFillColor(value: int) → None

getShowSliceMobilizedSupportForces() → bool

setShowSliceMobilizedSupportForces(value: bool) → None

getSliceHatchStyle() → DisplayHatchStyle

setSliceHatchStyle(value: DisplayHatchStyle) → None

getShowFsAtGridPoints() → bool

setShowFsAtGridPoints(value: bool) → None

getShowGridPoints() → bool

setShowGridPoints(value: bool) → None

getShowInvalidFsAtGridPoints() → bool

setShowInvalidFsAtGridPoints(value: bool) → None

getShowSpecificSurfaces() → bool

setShowSpecificSurfaces(value: bool) → None

getShowLinesToCenter() → bool

setShowLinesToCenter(value: bool) → None

getShowGrid() → bool

setShowGrid(value: bool) → None

getShowSearchObjects() → bool

setShowSearchObjects(value: bool) → None

getDrawVerticalSegments() → bool

setDrawVerticalSegments(value: bool) → None

getShowMaterialColors() → bool

setShowMaterialColors(value: bool) → None

getShowCentersOfRotation() → bool

setShowCentersOfRotation(value: bool) → None

getDrawAccurateArcs() → bool

setDrawAccurateArcs(value: bool) → None

getDrawResultsInFrontLoads() → bool

setDrawResultsInFrontLoads(value: bool) → None

getDrawResultsInFrontSupport() → bool

setDrawResultsInFrontSupport(value: bool) → None

getDrawResultsInFrontBoundaries() → bool

setDrawResultsInFrontBoundaries(value: bool) → None

getShowWaterGridsValues() → bool

setShowWaterGridsValues(value: bool) → None

getShowWaterGridsSymbols() → bool

setShowWaterGridsSymbols(value: bool) → None

getShowLoads() → bool

setShowLoads(value: bool) → None

getShowSupports() → bool

setShowSupports(value: bool) → None

getShowFacePlates() → bool

setShowFacePlates(value: bool) → None

getShowSlopeLimits() → bool

setShowSlopeLimits(value: bool) → None

getShowLoadText() → bool

setShowLoadText(value: bool) → None

getShowSeismicSymbol() → bool

setShowSeismicSymbol(value: bool) → None

getShowTensionCrackSymbols() → bool

setShowTensionCrackSymbols(value: bool) → None

getShowWaterSymbols() → bool

setShowWaterSymbols(value: bool) → None

getShowFsText() → bool

setShowFsText(value: bool) → None

getGlobalMinimumSurfaceColour() → int

setGlobalMinimumSurfaceColour(value: int) → None

getGlobalMinimumSurfaceLineWidth() → int

setGlobalMinimumSurfaceLineWidth(value: int) → None

getSlipSurfaceQueryColor() → int

setSlipSurfaceQueryColor(value: int) → None

getSlipSurfaceQueryLineWidth() → int

setSlipSurfaceQueryLineWidth(value: int) → None

getScaleFsTextWithZoom() → bool

setScaleFsTextWithZoom(value: bool) → None

getShowBoundaryConditionValues() → bool

setShowBoundaryConditionValues(value: bool) → None

getShowSteadyStateBoundaryConditions() → bool

setShowSteadyStateBoundaryConditions(value: bool) → None

getShowTransientBoundaryConditions() → bool

setShowTransientBoundaryConditions(value: bool) → None

getShowDiscretizations() → bool

setShowDiscretizations(value: bool) → None

getShowGroundwaterNodeNumbers() → bool

setShowGroundwaterNodeNumbers(value: bool) → None

getShowGroundwaterElementNumbers() → bool

setShowGroundwaterElementNumbers(value: bool) → None

getShrinkContours() → bool

setShrinkContours(value: bool) → None

getShowGroundwaterElements() → bool

setShowGroundwaterElements(value: bool) → None

getShrinkElements() → bool

setShrinkElements(value: bool) → None

getShowMidsideNodes() → bool

setShowMidsideNodes(value: bool) → None

getShowFeaWaterTable() → bool

setShowFeaWaterTable(value: bool) → None

getShowDischargeSections() → bool

setShowDischargeSections(value: bool) → None

getShowFlowVectors() → bool

setShowFlowVectors(value: bool) → None

getLongestVectorLength() → int

setLongestVectorLength(value: int) → None

getShowStrengthFunctionSymbols() → bool

setShowStrengthFunctionSymbols(value: bool) → None

getShowStrengthFunctionValues() → bool

setShowStrengthFunctionValues(value: bool) → None

getFeaWaterTableColor() → int

setFeaWaterTableColor(value: int) → None

getShowFeaWaterAllStages() → bool

setShowFeaWaterAllStages(value: bool) → None

getFlowVectorsColor() → int

setFlowVectorsColor(value: int) → None

getShowDischargeValues() → bool

setShowDischargeValues(value: bool) → None

getSfFont() → SlideFontOptions

setSfFont(value: SlideFontOptions) → None

getCopyModelerToolsOnOpen() → bool

setCopyModelerToolsOnOpen(value: bool) → None

getDischargeArrowScaleFactor() → float

setDischargeArrowScaleFactor(value: float) → None

getDischargeArrowOffset() → float

setDischargeArrowOffset(value: float) → None

getClrBoltForceArrows() → int

setClrBoltForceArrows(value: int) → None

getBoltForceArrowScaleFactor() → float

setBoltForceArrowScaleFactor(value: float) → None