MechanicalGraphicsWrapper

class ansys.mechanical.stubs.v261.Ansys.ACT.Common.Graphics.MechanicalGraphicsWrapper(mechanicalApi: Ansys.ACT.Mechanical.MechanicalAPI, graphics: Ansys.Common.Interop.Gfx.IDSGraphics)

Bases: object

Wrapper for Graphics in Mechanical.

Overview

Methods

CreateAndOpenDraw3DContext	CreateAndOpenDraw3DContext method.
CreatePixelPoint	Creates a point from pixel coordinates (ie. window coordinates).
CreateVector3D	Create a 3D vector from world coordinates.
CreateWorldPoint	Create a point from world coordinates.
DisplayResultsSubscopedToSelection	DisplayResultsSubscopedToSelection method.
DrawText2D	DrawText2D method.
Equals	Equals method.
Export3D	Exports the current Graphics display in a 3d format to a file.
ExportImage	Exports the current graphics display to a 2D image file.
ExportImageToClipboard	ExportImageToClipboard method.
ExportScreenToImage	ExportScreenToImage method.
ExportViewportChart	Exports the specified viewport's chart to file.
ExportViewportImage	Exports the current graphics display to a 2D image file.
ExportViewports	Creates a composite of images exported from each open viewport.
ForceResume	Forces the scene to resume. Useful in interactive context (console) if a reference on an
FullRedraw	FullRedraw method.
GetHashCode	GetHashCode method.
GetScenegraphForActiveObject	GetScenegraphForActiveObject method.
GetType	GetType method.
ImportLegend	ImportLegend method.
IsCurrentObjectAResult	IsCurrentObjectAResult method.
IsFESelectionOn	IsFESelectionOn method.
IsSubscopingOn	IsSubscopingOn method.
LineTo2D	LineTo2D method.
MoveTo2D	MoveTo2D method.
PixelToWorld	PixelToWorld method.
Redraw	Forces the scene to redraw its content.
RemoveContext	RemoveContext method.
ResetResultsSubscopedToSelection	ResetResultsSubscopedToSelection method.
Suspend	Prevents the scene to redraw until the Resume controller method was called.
ToString	ToString method.
VerifyLocaleStringsAreAllRenderable	Performs a test to see if all characters present in all locale dsstringtable.xml files can be found via DSGStream's TextEngine
WorldToPixel	WorldToPixel method.
add_ExtendObjectsToDisplay	add_ExtendObjectsToDisplay method.
remove_ExtendObjectsToDisplay	remove_ExtendObjectsToDisplay method.

Properties

AcceleratedGraphics	Gets or sets the Accelerated Graphics Preference
AdvancedRenderingIsSupported	AdvancedRenderingIsSupported property.
Camera	Gets the camera.
CanPlotDisplacementTraces	CanPlotDisplacementTraces property.
Color	Color property.
DepthTest	DepthTest property.
DrawContexts	DrawContexts property.
GlobalLegendSettings	Gets the Global Graphics Legend Settings.
ImageCompare	ImageCompare property.
ImageExportRescaleGraphOverlayPreference	Gets or sets the Image Export Rescale Graph Overlay Preference
InternalObject	InternalObject property.
KeyframeAnimationUtility	A utility for creating animations based on keyframes.
LabelManager	Manages labels and the creation and deletion of them.
LineWeight	LineWeight property.
ModelViewManager	An instance of the ModelViewManager.
OverlayManager	Manages overlays and the creation and deletion of them.
ResultAnimationOptions	Gets the Global Result Animation options.
RotateAngle	RotateAngle property.
Scene	Gets the scene.
SectionPlanes	Returns the collection of section planes used by graphics
Translucency	Translucency property.
Unit	Gets the current graphics unit.
ViewOptions	Gets the Graphics View Options.
WebData	WebData property.

Property detail

property MechanicalGraphicsWrapper.AcceleratedGraphics: Ansys.Mechanical.DataModel.Enums.AccGraphicsPreference | None

Gets or sets the Accelerated Graphics Preference

property MechanicalGraphicsWrapper.AdvancedRenderingIsSupported: bool | None

AdvancedRenderingIsSupported property.

property MechanicalGraphicsWrapper.Camera: Ansys.ACT.Common.Graphics.MechanicalCameraWrapper | None

Gets the camera.

property MechanicalGraphicsWrapper.CanPlotDisplacementTraces: bool | None

CanPlotDisplacementTraces property.

property MechanicalGraphicsWrapper.Color: int | None

Color property.

property MechanicalGraphicsWrapper.DepthTest: bool | None

DepthTest property.

property MechanicalGraphicsWrapper.DrawContexts: List[Ansys.ACT.Interfaces.Graphics.IDrawContext] | None

DrawContexts property.

property MechanicalGraphicsWrapper.GlobalLegendSettings: Ansys.Mechanical.Graphics.GlobalLegendSettings | None

Gets the Global Graphics Legend Settings.

property MechanicalGraphicsWrapper.ImageCompare: Ansys.ACT.Common.Graphics.ImageCompare | None

ImageCompare property.

property MechanicalGraphicsWrapper.ImageExportRescaleGraphOverlayPreference: bool | None

Gets or sets the Image Export Rescale Graph Overlay Preference

property MechanicalGraphicsWrapper.InternalObject: Ansys.Common.Interop.Gfx.IDSGraphics | None

InternalObject property.

property MechanicalGraphicsWrapper.KeyframeAnimationUtility: Ansys.ACT.Common.Graphics.KeyframeAnimationUtility | None

A utility for creating animations based on keyframes.

property MechanicalGraphicsWrapper.LabelManager: Ansys.Mechanical.Graphics.Labels.LabelManager | None

Manages labels and the creation and deletion of them.

property MechanicalGraphicsWrapper.LineWeight: int | None

LineWeight property.

property MechanicalGraphicsWrapper.ModelViewManager: Ansys.ACT.Interfaces.Graphics.IModelViewManager | None

An instance of the ModelViewManager.

property MechanicalGraphicsWrapper.OverlayManager: Ansys.Mechanical.Graphics.OverlayManager | None

Manages overlays and the creation and deletion of them.

property MechanicalGraphicsWrapper.ResultAnimationOptions: Ansys.Mechanical.Graphics.ResultAnimationOptions | None

Gets the Global Result Animation options.

property MechanicalGraphicsWrapper.RotateAngle: float | None

RotateAngle property.

property MechanicalGraphicsWrapper.Scene: Ansys.ACT.Interfaces.Graphics.IGraphicsCollection | None

Gets the scene.

property MechanicalGraphicsWrapper.SectionPlanes: Ansys.Mechanical.Graphics.SectionPlanes | None

Returns the collection of section planes used by graphics

property MechanicalGraphicsWrapper.Translucency: float | None

Translucency property.

property MechanicalGraphicsWrapper.Unit: str | None

Gets the current graphics unit.

property MechanicalGraphicsWrapper.ViewOptions: Ansys.Mechanical.Graphics.ViewOptions | None

Gets the Graphics View Options.

property MechanicalGraphicsWrapper.WebData: Ansys.ACT.Common.Graphics.GraphicsWebData | None

WebData property.

Method detail

MechanicalGraphicsWrapper.CreateAndOpenDraw3DContext() → Ansys.ACT.Interfaces.Graphics.IDraw3DContext

CreateAndOpenDraw3DContext method.

MechanicalGraphicsWrapper.CreatePixelPoint(x: int, y: int) → Ansys.ACT.Interfaces.Graphics.IPixelPoint

Creates a point from pixel coordinates (ie. window coordinates).

MechanicalGraphicsWrapper.CreateVector3D(x: float, y: float, z: float) → Ansys.ACT.Interfaces.Graphics.IVector3D

Create a 3D vector from world coordinates.

MechanicalGraphicsWrapper.CreateWorldPoint(x: float, y: float, z: float) → Ansys.ACT.Interfaces.Graphics.IWorldPoint

Create a point from world coordinates.

MechanicalGraphicsWrapper.DisplayResultsSubscopedToSelection(subs_sel_type: Ansys.Mechanical.DataModel.MechanicalEnums.Graphics.SubscopingSelectionType) → None

DisplayResultsSubscopedToSelection method.

MechanicalGraphicsWrapper.DrawText2D(x: int, y: int, text: str) → None

DrawText2D method.

MechanicalGraphicsWrapper.Equals(obj: Any) → bool

Equals method.

MechanicalGraphicsWrapper.Export3D(filePath: str, format3d: Ansys.Mechanical.DataModel.Enums.Graphics3DExportFormat, settings: Ansys.Mechanical.Graphics.Graphics3DExportSettings) → None

Exports the current Graphics display in a 3d format to a file.

MechanicalGraphicsWrapper.ExportImage(filePath: str, formatImage: Ansys.Mechanical.DataModel.Enums.GraphicsImageExportFormat, settings: Ansys.Mechanical.Graphics.GraphicsImageExportSettings) → None

Exports the current graphics display to a 2D image file.

MechanicalGraphicsWrapper.ExportImageToClipboard(settings: Ansys.Mechanical.Graphics.GraphicsImageExportSettings) → None

ExportImageToClipboard method.

MechanicalGraphicsWrapper.ExportScreenToImage(filePath: str) → None

ExportScreenToImage method.

MechanicalGraphicsWrapper.ExportViewportChart(viewportIndex: int, filePath: str, width: int, height: int, formatImage: Ansys.Mechanical.DataModel.Enums.GraphicsImageExportFormat) → None

Exports the specified viewport's chart to file.

MechanicalGraphicsWrapper.ExportViewportImage(viewportIndex: int, filePath: str, formatImage: Ansys.Mechanical.DataModel.Enums.GraphicsImageExportFormat, settings: Ansys.Mechanical.Graphics.GraphicsImageExportSettings) → None

Exports the current graphics display to a 2D image file.

MechanicalGraphicsWrapper.ExportViewports(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsImageExportFormat, settings: Ansys.Mechanical.Graphics.GraphicsViewportsExportSettings) → None

Creates a composite of images exported from each open viewport.

MechanicalGraphicsWrapper.ForceResume() → None

Forces the scene to resume. Useful in interactive context (console) if a reference on an
operation has been lost.

MechanicalGraphicsWrapper.FullRedraw() → None

FullRedraw method.

MechanicalGraphicsWrapper.GetHashCode() → int

GetHashCode method.

MechanicalGraphicsWrapper.GetScenegraphForActiveObject() → Ansys.Mechanical.Scenegraph.Node

GetScenegraphForActiveObject method.

MechanicalGraphicsWrapper.GetType() → type

GetType method.

MechanicalGraphicsWrapper.ImportLegend(filePath: str, unit: str) → Ansys.Mechanical.Graphics.Tools.LegendSettings

ImportLegend method.

MechanicalGraphicsWrapper.IsCurrentObjectAResult() → bool

IsCurrentObjectAResult method.

MechanicalGraphicsWrapper.IsFESelectionOn() → bool

IsFESelectionOn method.

MechanicalGraphicsWrapper.IsSubscopingOn() → bool

IsSubscopingOn method.

MechanicalGraphicsWrapper.LineTo2D(x: int, y: int) → None

LineTo2D method.

MechanicalGraphicsWrapper.MoveTo2D(x: int, y: int) → None

MoveTo2D method.

MechanicalGraphicsWrapper.PixelToWorld(xy: Iterable[int]) → float

PixelToWorld method.

MechanicalGraphicsWrapper.Redraw() → None

Forces the scene to redraw its content.

MechanicalGraphicsWrapper.RemoveContext(context: Ansys.ACT.Interfaces.Graphics.IDrawContext) → None

RemoveContext method.

MechanicalGraphicsWrapper.ResetResultsSubscopedToSelection() → None

ResetResultsSubscopedToSelection method.

MechanicalGraphicsWrapper.Suspend() → Ansys.ACT.Interfaces.Graphics.ISuspendController

Prevents the scene to redraw until the Resume controller method was called.

MechanicalGraphicsWrapper.ToString() → str

ToString method.

MechanicalGraphicsWrapper.VerifyLocaleStringsAreAllRenderable() → tuple[str, bool]

Performs a test to see if all characters present in all locale dsstringtable.xml files can be found via DSGStream's TextEngine

MechanicalGraphicsWrapper.WorldToPixel(pt: Iterable[float]) → int

WorldToPixel method.

MechanicalGraphicsWrapper.add_ExtendObjectsToDisplay(value: System.EventHandler[Ansys.ACT.Common.Graphics.ExtendObjectsToDisplayArgs]) → None

add_ExtendObjectsToDisplay method.

MechanicalGraphicsWrapper.remove_ExtendObjectsToDisplay(value: System.EventHandler[Ansys.ACT.Common.Graphics.ExtendObjectsToDisplayArgs]) → None

remove_ExtendObjectsToDisplay method.