MarkerBatchPrimitiveFactory

class ansys.stk.core.graphics.MarkerBatchPrimitiveFactory

Render one or more markers in the 3D scene. Markers are 2D images that always face the viewer which can be sized in pixels or meters. Markers are also referred to as sprites or billboards…

Overview

Methods

initialize	Initialize a default marker batch primitive…
initialize_with_set_hint	Initialize a marker batch primitive with the specified setHint…
initialize_with_size_source	Initialize a marker batch primitive with the specified sizeSource…
initialize_with_size_source_and_sort_order	Initialize a marker batch primitive with the specified sizeSource and sortOrder…
initialize_size_source_sort_order_and_set_hint	Initialize a marker batch primitive with the specified sizeSource, sortOrder, and setHint. This is equivalent to constructing a marker batch with the specified arguments and a marker batch rendering method of Automatic.
initialize_size_source_sort_order_set_hint_and_rendering_method	Initialize a marker batch primitive with the specified arguments.
supported	Determine whether or not the video card supports the marker batch primitive with the given renderingMethod.

Import detail

from ansys.stk.core.graphics import MarkerBatchPrimitiveFactory

Method detail

MarkerBatchPrimitiveFactory.initialize(self) → MarkerBatchPrimitive

Initialize a default marker batch primitive…

Returns:

MarkerBatchPrimitive

MarkerBatchPrimitiveFactory.initialize_with_set_hint(self, set_hint: SetHint) → MarkerBatchPrimitive

Initialize a marker batch primitive with the specified setHint…

Parameters:

set_hint : SetHint

Returns:

MarkerBatchPrimitive

MarkerBatchPrimitiveFactory.initialize_with_size_source(self, size_source: MarkerBatchSizeSource) → MarkerBatchPrimitive

Initialize a marker batch primitive with the specified sizeSource…

Parameters:

size_source : MarkerBatchSizeSource

Returns:

MarkerBatchPrimitive

MarkerBatchPrimitiveFactory.initialize_with_size_source_and_sort_order(self, size_source: MarkerBatchSizeSource, sort_order: MarkerBatchSortOrder) → MarkerBatchPrimitive

Initialize a marker batch primitive with the specified sizeSource and sortOrder…

Parameters:

size_source : MarkerBatchSizeSource

sort_order : MarkerBatchSortOrder

Returns:

MarkerBatchPrimitive

MarkerBatchPrimitiveFactory.initialize_size_source_sort_order_and_set_hint(self, size_source: MarkerBatchSizeSource, sort_order: MarkerBatchSortOrder, set_hint: SetHint) → MarkerBatchPrimitive

Initialize a marker batch primitive with the specified sizeSource, sortOrder, and setHint. This is equivalent to constructing a marker batch with the specified arguments and a marker batch rendering method of Automatic.

Parameters:

size_source : MarkerBatchSizeSource

sort_order : MarkerBatchSortOrder

set_hint : SetHint

Returns:

MarkerBatchPrimitive

MarkerBatchPrimitiveFactory.initialize_size_source_sort_order_set_hint_and_rendering_method(self, size_source: MarkerBatchSizeSource, sort_order: MarkerBatchSortOrder, set_hint: SetHint, rendering_method: MarkerBatchRenderingMethod) → MarkerBatchPrimitive

Initialize a marker batch primitive with the specified arguments.

Parameters:

size_source : MarkerBatchSizeSource

sort_order : MarkerBatchSortOrder

set_hint : SetHint

rendering_method : MarkerBatchRenderingMethod

Returns:

MarkerBatchPrimitive

MarkerBatchPrimitiveFactory.supported(self, rendering_method: MarkerBatchRenderingMethod) → bool

Determine whether or not the video card supports the marker batch primitive with the given renderingMethod.

Parameters:

rendering_method : MarkerBatchRenderingMethod

Returns:

bool