SectionPlanes

class ansys.mechanical.stubs.v261.Ansys.Mechanical.Graphics.SectionPlanes(graphics: Ansys.Common.Interop.Gfx.IDSGraphics)

Bases: object

Represents the collection of section planes used by graphics

Overview

Methods

Add	Adds the given SectionPlane object to the collection to modify the view. Currently only 6 SectionPlane objects in the collection can be activated at once.
Clear	Clears the collection of all SectionPlane objects.
Contains	Returns true if the SectionPlane belongs to the collection.
CopyTo	CopyTo method.
CreateSectionPlane	Creates a SectionPlane based on a coordinate system and plane orientation.
Equals	Equals method.
GetEnumerator	GetEnumerator method.
GetHashCode	GetHashCode method.
GetType	GetType method.
IndexOf	Returns the index of the SectionObject if in the collection. Returns -1 if not found.
Remove	Removes the requested SectionPlane from the collection.
RemoveAt	Removes the SectionPlane at the given index.
ToString	ToString method.

Properties

Capping	Gets or Sets the Capping style of the Section Plane
Count	The number of section planes in the collection.
IsReadOnly	IsReadOnly property.
Item	Item property.
ShowHatching	Controls whether to render hatch lines (the black parallel lines) on the capped surfaces of section planes. Default: true
ShowWholeElement	Gets or Sets the Element Visibility of the Section Plane

Property detail

property SectionPlanes.Capping: Ansys.Mechanical.DataModel.Enums.SectionPlaneCappingType | None

Gets or Sets the Capping style of the Section Plane

property SectionPlanes.Count: int | None

The number of section planes in the collection.

property SectionPlanes.IsReadOnly: bool | None

IsReadOnly property.

property SectionPlanes.Item: Ansys.Mechanical.Graphics.SectionPlane | None

Item property.

property SectionPlanes.ShowHatching: bool | None

Controls whether to render hatch lines (the black parallel lines) on the capped surfaces of section planes. Default: true

property SectionPlanes.ShowWholeElement: bool | None

Gets or Sets the Element Visibility of the Section Plane

Method detail

SectionPlanes.Add(sectionPlane: Ansys.Mechanical.Graphics.SectionPlane) → None

Adds the given SectionPlane object to the collection to modify the view. Currently only 6 SectionPlane objects in the collection can be activated at once.

SectionPlanes.Clear() → None

Clears the collection of all SectionPlane objects.

SectionPlanes.Contains(item: Ansys.Mechanical.Graphics.SectionPlane) → bool

Returns true if the SectionPlane belongs to the collection.

SectionPlanes.CopyTo(array: Ansys.Mechanical.Graphics.SectionPlane, arrayIndex: int) → None

CopyTo method.

SectionPlanes.CreateSectionPlane(coordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem, planeOrientation: Ansys.Mechanical.DataModel.MechanicalEnums.Common.PlaneOrientation) → Ansys.Mechanical.Graphics.SectionPlane

Creates a SectionPlane based on a coordinate system and plane orientation.

SectionPlanes.Equals(obj: Any) → bool

Equals method.

SectionPlanes.GetEnumerator() → Ansys.Mechanical.Graphics.SectionPlaneList

GetEnumerator method.

SectionPlanes.GetHashCode() → int

GetHashCode method.

SectionPlanes.GetType() → type

GetType method.

SectionPlanes.IndexOf(sectionPlane: Ansys.Mechanical.Graphics.SectionPlane) → int

Returns the index of the SectionObject if in the collection. Returns -1 if not found.

SectionPlanes.Remove(sectionPlane: Ansys.Mechanical.Graphics.SectionPlane) → bool

Removes the requested SectionPlane from the collection.

SectionPlanes.RemoveAt(index: int) → None

Removes the SectionPlane at the given index.

SectionPlanes.ToString() → str

ToString method.