SurfaceShapesInitializer#

class ansys.stk.core.graphics.SurfaceShapesInitializer#

Compute boundary positions for shapes on the surface such as circles, ellipses, and sectors.

Overview#

compute_circle_with_granularity

Compute boundary positions for a circle on the specified centralBody with the specified center, radius and granularity.

compute_circle

Compute boundary positions for a circle on the specified centralBody with the specified center and radius. This is equivalent to calling ComputeCircle with a granularity of 1 degree.

compute_circle_cartographic_with_granularity

For convenience. Computes boundary positions for a circle on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeCircle.

compute_circle_cartographic

For convenience. Computes boundary positions for a circle on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeCircle.

compute_ellipse_with_granularity

Compute boundary positions for an ellipse on the specified centralBody.

compute_ellipse

Compute boundary positions for an ellipse on the specified centralBody. This is equivalent to calling ComputeEllipse with a granularity of 1 degree.

compute_ellipse_cartographic_with_granularity

For convenience. Computes boundary positions for an ellipse on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeEllipse.

compute_ellipse_cartographic

For convenience. Computes boundary positions for an ellipse on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeEllipse.

compute_sector_with_granularity

Compute boundary positions for a sector on the specified centralBody.

compute_sector

Compute boundary positions for a sector on the specified centralBody. This is equivalent to calling ComputeSector with a granularity of 1 degree.

compute_sector_cartographic_with_granularity

For convenience. Computes boundary positions for a sector on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeSector.

compute_sector_cartographic

For convenience. Computes boundary positions for a sector on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeSector.

Import detail#

from ansys.stk.core.graphics import SurfaceShapesInitializer

Method detail#

SurfaceShapesInitializer.compute_circle_with_granularity(self, central_body: str, center: list, radius: float, granularity: float) SurfaceShapesResult#

Compute boundary positions for a circle on the specified centralBody with the specified center, radius and granularity.

Parameters:

central_body : str

center : list

radius : float

granularity : float

Returns:

SurfaceShapesResult

SurfaceShapesInitializer.compute_circle(self, central_body: str, center: list, radius: float) SurfaceShapesResult#

Compute boundary positions for a circle on the specified centralBody with the specified center and radius. This is equivalent to calling ComputeCircle with a granularity of 1 degree.

Parameters:

central_body : str

center : list

radius : float

Returns:

SurfaceShapesResult

SurfaceShapesInitializer.compute_circle_cartographic_with_granularity(self, central_body: str, center: list, radius: float, granularity: float) SurfaceShapesResult#

For convenience. Computes boundary positions for a circle on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeCircle.

Parameters:

central_body : str

center : list

radius : float

granularity : float

Returns:

SurfaceShapesResult

SurfaceShapesInitializer.compute_circle_cartographic(self, central_body: str, center: list, radius: float) SurfaceShapesResult#

For convenience. Computes boundary positions for a circle on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeCircle.

Parameters:

central_body : str

center : list

radius : float

Returns:

SurfaceShapesResult

SurfaceShapesInitializer.compute_ellipse_with_granularity(self, central_body: str, center: list, major_axis_radius: float, minor_axis_radius: float, bearing: float, granularity: float) SurfaceShapesResult#

Compute boundary positions for an ellipse on the specified centralBody.

Parameters:

central_body : str

center : list

major_axis_radius : float

minor_axis_radius : float

bearing : float

granularity : float

Returns:

SurfaceShapesResult

SurfaceShapesInitializer.compute_ellipse(self, central_body: str, center: list, major_axis_radius: float, minor_axis_radius: float, bearing: float) SurfaceShapesResult#

Compute boundary positions for an ellipse on the specified centralBody. This is equivalent to calling ComputeEllipse with a granularity of 1 degree.

Parameters:

central_body : str

center : list

major_axis_radius : float

minor_axis_radius : float

bearing : float

Returns:

SurfaceShapesResult

SurfaceShapesInitializer.compute_ellipse_cartographic_with_granularity(self, central_body: str, center: list, major_axis_radius: float, minor_axis_radius: float, bearing: float, granularity: float) SurfaceShapesResult#

For convenience. Computes boundary positions for an ellipse on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeEllipse.

Parameters:

central_body : str

center : list

major_axis_radius : float

minor_axis_radius : float

bearing : float

granularity : float

Returns:

SurfaceShapesResult

SurfaceShapesInitializer.compute_ellipse_cartographic(self, central_body: str, center: list, major_axis_radius: float, minor_axis_radius: float, bearing: float) SurfaceShapesResult#

For convenience. Computes boundary positions for an ellipse on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeEllipse.

Parameters:

central_body : str

center : list

major_axis_radius : float

minor_axis_radius : float

bearing : float

Returns:

SurfaceShapesResult

SurfaceShapesInitializer.compute_sector_with_granularity(self, central_body: str, center: list, inner_radius: float, outer_radius: float, start_bearing: float, end_bearing: float, granularity: float) SurfaceShapesResult#

Compute boundary positions for a sector on the specified centralBody.

Parameters:

central_body : str

center : list

inner_radius : float

outer_radius : float

start_bearing : float

end_bearing : float

granularity : float

Returns:

SurfaceShapesResult

SurfaceShapesInitializer.compute_sector(self, central_body: str, center: list, inner_radius: float, outer_radius: float, start_bearing: float, end_bearing: float) SurfaceShapesResult#

Compute boundary positions for a sector on the specified centralBody. This is equivalent to calling ComputeSector with a granularity of 1 degree.

Parameters:

central_body : str

center : list

inner_radius : float

outer_radius : float

start_bearing : float

end_bearing : float

Returns:

SurfaceShapesResult

SurfaceShapesInitializer.compute_sector_cartographic_with_granularity(self, central_body: str, center: list, inner_radius: float, outer_radius: float, start_bearing: float, end_bearing: float, granularity: float) SurfaceShapesResult#

For convenience. Computes boundary positions for a sector on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeSector.

Parameters:

central_body : str

center : list

inner_radius : float

outer_radius : float

start_bearing : float

end_bearing : float

granularity : float

Returns:

SurfaceShapesResult

SurfaceShapesInitializer.compute_sector_cartographic(self, central_body: str, center: list, inner_radius: float, outer_radius: float, start_bearing: float, end_bearing: float) SurfaceShapesResult#

For convenience. Computes boundary positions for a sector on the specified centralBody using a cartographic center. This is equivalent to converting center to cartesian and calling ComputeSector.

Parameters:

central_body : str

center : list

inner_radius : float

outer_radius : float

start_bearing : float

end_bearing : float

Returns:

SurfaceShapesResult