CentralBodyGraphicsIndexer

class ansys.stk.core.graphics.CentralBodyGraphicsIndexer

An indexer into the central body graphics for a particular central body, which provides graphical properties such as showing or hiding the central body in the scene, and working with terrain and imagery for the specified central body.

Overview

Methods

item	Get the central body graphics for the specified central body.
get_by_name	Return the central body graphics for the central body with the given name.

Properties

earth	Get the central body graphics for the planet Earth. This is equivalent to passing a central body equal to an instance of earth central body to the indexer.
moon	Get the central body graphics for the Moon.
sun	Get the central body graphics for the Sun.

Import detail

from ansys.stk.core.graphics import CentralBodyGraphicsIndexer

Property detail

property CentralBodyGraphicsIndexer.earth: CentralBodyGraphics

Get the central body graphics for the planet Earth. This is equivalent to passing a central body equal to an instance of earth central body to the indexer.

property CentralBodyGraphicsIndexer.moon: CentralBodyGraphics

Get the central body graphics for the Moon.

property CentralBodyGraphicsIndexer.sun: CentralBodyGraphics

Get the central body graphics for the Sun.

Method detail

CentralBodyGraphicsIndexer.item(self, central_body: str) → CentralBodyGraphics

Get the central body graphics for the specified central body.

Parameters:

central_body : str

Returns:

CentralBodyGraphics

CentralBodyGraphicsIndexer.get_by_name(self, name: str) → CentralBodyGraphics

Return the central body graphics for the central body with the given name.

Parameters:

name : str

Returns:

CentralBodyGraphics