SceneDisplayCondition

class ansys.stk.core.graphics.SceneDisplayCondition

Bases: IDisplayCondition

A display condition used to control what scene or scenes an object, such as a primitive, is rendered in. This is used to show an object in some scenes and hide it in others.

Overview

Methods

display_only_in_scene	Allow rendering only in the given scene. The display condition will not allow rendering in other scenes, including newly created ones.
get_display_in_scene	Determine whether the display condition allows rendering rendering in the given scene.
set_display_in_scene	Allow or disallows rendering for in a particular scene for.

Import detail

from ansys.stk.core.graphics import SceneDisplayCondition

Method detail

SceneDisplayCondition.display_only_in_scene(self, scene: Scene) → None

Allow rendering only in the given scene. The display condition will not allow rendering in other scenes, including newly created ones.

Parameters:

scene : Scene

Returns:

None

SceneDisplayCondition.get_display_in_scene(self, scene: Scene) → bool

Determine whether the display condition allows rendering rendering in the given scene.

Parameters:

scene : Scene

Returns:

bool

SceneDisplayCondition.set_display_in_scene(self, scene: Scene, on: bool) → None

Allow or disallows rendering for in a particular scene for.

Parameters:

scene : Scene

on : bool

Returns:

None