Graphics3DModelArticulation

class ansys.stk.core.stkobjects.Graphics3DModelArticulation

Class defining 3D model articulations.

Overview

Methods

get_available_articulations	Get the available articulations.
get_available_transformations	Get the available transformations.
get_transformation_value	Get the Transformation Value given the LOD (level of detail), articulation name and the transformation name.
set_transformation_value	Set the Transformation Value given the LOD and articulation name.

Properties

enable_default_save	Save the articulation value as the default for all future sessions using this model. The articulation value is saved with the object and not with the model or articulation files.
graphics_3d_articulation_file	Interface to specify articulation file.
level_of_detail_count	Specify the level of detail (LOD) for defining articulations, where 0 is the finest level of detail and 1 is the coarsest model.
save_articulation_file_on_save	Save articulation file associated with the model when the object is saved.
use_articulation_file	Use the articulation from the specified file.
use_object_color_for_model	Set Model Color to facility color if color articulation exists.

Import detail

from ansys.stk.core.stkobjects import Graphics3DModelArticulation

Property detail

property Graphics3DModelArticulation.enable_default_save: bool

Save the articulation value as the default for all future sessions using this model. The articulation value is saved with the object and not with the model or articulation files.

property Graphics3DModelArticulation.graphics_3d_articulation_file: Graphics3DArticulationFile

Interface to specify articulation file.

property Graphics3DModelArticulation.level_of_detail_count: int

Specify the level of detail (LOD) for defining articulations, where 0 is the finest level of detail and 1 is the coarsest model.

property Graphics3DModelArticulation.save_articulation_file_on_save: bool

Save articulation file associated with the model when the object is saved.

property Graphics3DModelArticulation.use_articulation_file: bool

Use the articulation from the specified file.

property Graphics3DModelArticulation.use_object_color_for_model: bool

Set Model Color to facility color if color articulation exists.

Method detail

Graphics3DModelArticulation.get_available_articulations(self, level_of_detail: int) → list

Get the available articulations.

Parameters:

level_of_detail : int

Returns:

list

Graphics3DModelArticulation.get_available_transformations(self, level_of_detail: int, artic_name: str) → Graphics3DModelTransformationCollection

Get the available transformations.

Parameters:

level_of_detail : int

artic_name : str

Returns:

Graphics3DModelTransformationCollection

Graphics3DModelArticulation.get_transformation_value(self, level_of_detail: int, articulation: str, trans: str) → float

Get the Transformation Value given the LOD (level of detail), articulation name and the transformation name.

Parameters:

level_of_detail : int

articulation : str

trans : str

Returns:

float

Graphics3DModelArticulation.set_transformation_value(self, level_of_detail: int, articulation: str, trans: str, transformation_value: float) → None

Set the Transformation Value given the LOD and articulation name.

Parameters:

level_of_detail : int

articulation : str

trans : str

transformation_value : float

Returns:

None