SensorGraphics3DOffset

class ansys.stk.core.stkobjects.SensorGraphics3DOffset

Class defining 3D Graphics vertex offset properties of a Sensor.

Overview

Methods

get_axis_offset_value	Get the selected axis offset type.
set_axis_offset_value	Select the axis offset type.

Properties

inherit_from_parent_obj	Opt whether to use the position offset from the parent object.
enable_translational	Opt whether to specify the sensor projection starting point position offset in the parent object’s body frame in the X, Y and Z directions.
x	Offset in the X direction. Uses Distance Dimension.
y	Offset in the Y direction. Uses Distance Dimension.
z	Offset in the Z direction. Uses Distance Dimension.
enable_attachment_point	Enable the use of an attach point, i.e. the place from which the sensor cone emits. If this feature is not used, the sensor cone origin is the center of the parent model.
attachment_point_name	Name of the attach point.
available_attachment_points	Return available attach points.

Import detail

from ansys.stk.core.stkobjects import SensorGraphics3DOffset

Property detail

property SensorGraphics3DOffset.inherit_from_parent_obj: bool

Opt whether to use the position offset from the parent object.

property SensorGraphics3DOffset.enable_translational: bool

Opt whether to specify the sensor projection starting point position offset in the parent object’s body frame in the X, Y and Z directions.

property SensorGraphics3DOffset.x: float

Offset in the X direction. Uses Distance Dimension.

property SensorGraphics3DOffset.y: float

Offset in the Y direction. Uses Distance Dimension.

property SensorGraphics3DOffset.z: float

Offset in the Z direction. Uses Distance Dimension.

property SensorGraphics3DOffset.enable_attachment_point: bool

Enable the use of an attach point, i.e. the place from which the sensor cone emits. If this feature is not used, the sensor cone origin is the center of the parent model.

property SensorGraphics3DOffset.attachment_point_name: str

Name of the attach point.

property SensorGraphics3DOffset.available_attachment_points: list

Return available attach points.

Method detail

SensorGraphics3DOffset.get_axis_offset_value(self, offset_type: AxisOffset) → float

Get the selected axis offset type.

Parameters:

offset_type : AxisOffset

Returns:

float

SensorGraphics3DOffset.set_axis_offset_value(self, offset_type: AxisOffset, axis_offset_value: float) → None

Select the axis offset type.

Parameters:

offset_type : AxisOffset

axis_offset_value : float

Returns:

None