Graphics3DBorderWall#

class ansys.stk.core.stkobjects.Graphics3DBorderWall#

Class defining 3D Graphics border wall properties.

Overview#

is_altitude_reference_type_supported

Provide verification of the availability of borderwall edge altitude reference.

use_border_wall

Display the border for the area target as a solid or translucent wall that extends from the lower edge altitude to the upper edge altitude.

upper_edge_altitude_reference

Reference used in defining the upper edge of the border wall. A member of the BorderWallUpperLowerEdgeAltitudeReference enumeration.

upper_edge_height

Height of the upper edge of the border wall.

lower_edge_altitude_reference

Reference used in defining the lower edge of the border wall. A member of the BorderWallUpperLowerEdgeAltitudeReference enumeration.

lower_edge_height

Height of the lower edge of the border wall.

use_wall_translucency

Display the border wall at the specified translucency percentage.

wall_translucency

Get or set the border wall’s translucency percentage, where 100% = invisible.

use_line_translucency

Display the lines at the upper and lower edges of the border wall at the specified translucency percentage.

line_translucency

Get or set the translucency of the lines at the upper and lower edges of the border wall, where 100% = invisible.

Import detail#

from ansys.stk.core.stkobjects import Graphics3DBorderWall

Property detail#

property Graphics3DBorderWall.use_border_wall: bool#

Display the border for the area target as a solid or translucent wall that extends from the lower edge altitude to the upper edge altitude.

property Graphics3DBorderWall.upper_edge_altitude_reference: BorderWallUpperLowerEdgeAltitudeReference#

Reference used in defining the upper edge of the border wall. A member of the BorderWallUpperLowerEdgeAltitudeReference enumeration.

property Graphics3DBorderWall.upper_edge_height: float#

Height of the upper edge of the border wall.

property Graphics3DBorderWall.lower_edge_altitude_reference: BorderWallUpperLowerEdgeAltitudeReference#

Reference used in defining the lower edge of the border wall. A member of the BorderWallUpperLowerEdgeAltitudeReference enumeration.

property Graphics3DBorderWall.lower_edge_height: float#

Height of the lower edge of the border wall.

property Graphics3DBorderWall.use_wall_translucency: bool#

Display the border wall at the specified translucency percentage.

property Graphics3DBorderWall.wall_translucency: float#

Get or set the border wall’s translucency percentage, where 100% = invisible.

property Graphics3DBorderWall.use_line_translucency: bool#

Display the lines at the upper and lower edges of the border wall at the specified translucency percentage.

property Graphics3DBorderWall.line_translucency: float#

Get or set the translucency of the lines at the upper and lower edges of the border wall, where 100% = invisible.

Method detail#

Graphics3DBorderWall.is_altitude_reference_type_supported(self, ref_type: BorderWallUpperLowerEdgeAltitudeReference) bool#

Provide verification of the availability of borderwall edge altitude reference.

Parameters:

ref_type : BorderWallUpperLowerEdgeAltitudeReference

Returns:

bool