IDirection

class ansys.stk.core.stkutil.IDirection

Interface to set and retrieve direction options for aligned and constrained vectors.

Overview

Methods

assign	Assign a new direction.
assign_euler	Set direction using the Euler representation. Params B and C use Angle Dimension.
assign_pr	Set direction using the Pitch Roll representation. Pitch and Roll use Angle Dimension.
assign_ra_dec	Set direction using the Right Ascension and Declination representation. Param Dec uses Latitude. Param RA uses Longitude.
assign_xyz	Set direction using the Cartesian representation. Params X, Y and Z are dimensionless.
convert_to	Change the direction to the type specified.
query_euler	Get direction using the Euler representation. Params B and C use Angle Dimension.
query_euler_array	Return the Euler elements in an array.
query_pr	Get direction using the Pitch Roll representation. Pitch and Roll use Angle Dimension.
query_pr_array	Return the PR elements in an array.
query_ra_dec	Get direction using the Right Ascension and Declination representation. Param Dec uses Latitude. Param RA uses Longitude.
query_ra_dec_array	Return the RADec elements in an array.
query_xyz	Get direction using the Cartesian representation. Params X, Y and Z are dimensionless.
query_xyz_array	Return the XYZ elements in an array.

Properties

direction_type

Return the type of direction currently being used.

Import detail

from ansys.stk.core.stkutil import IDirection

Property detail

property IDirection.direction_type: DirectionType

Return the type of direction currently being used.

Method detail

IDirection.assign(self, direction: IDirection) → None

Assign a new direction.

Parameters:

direction : IDirection

Returns:

None

IDirection.assign_euler(self, b: Any, c: Any, sequence: EulerDirectionSequence) → None

Set direction using the Euler representation. Params B and C use Angle Dimension.

Parameters:

b : Any

c : Any

sequence : EulerDirectionSequence

Returns:

None

IDirection.assign_pr(self, pitch: Any, roll: Any) → None

Set direction using the Pitch Roll representation. Pitch and Roll use Angle Dimension.

Parameters:

pitch : Any

roll : Any

Returns:

None

IDirection.assign_ra_dec(self, ra: Any, dec: Any) → None

Set direction using the Right Ascension and Declination representation. Param Dec uses Latitude. Param RA uses Longitude.

Parameters:

ra : Any

dec : Any

Returns:

None

IDirection.assign_xyz(self, x: float, y: float, z: float) → None

Set direction using the Cartesian representation. Params X, Y and Z are dimensionless.

Parameters:

x : float

y : float

z : float

Returns:

None

IDirection.convert_to(self, type: DirectionType) → IDirection

Change the direction to the type specified.

Parameters:

type : DirectionType

Returns:

IDirection

IDirection.query_euler(self, sequence: EulerDirectionSequence) → Tuple[Any, Any]

Get direction using the Euler representation. Params B and C use Angle Dimension.

Parameters:

sequence : EulerDirectionSequence

Returns:

Any]

IDirection.query_euler_array(self, sequence: EulerDirectionSequence) → list

Return the Euler elements in an array.

Parameters:

sequence : EulerDirectionSequence

Returns:

list

IDirection.query_pr(self, sequence: PRSequence) → Tuple[Any, Any]

Get direction using the Pitch Roll representation. Pitch and Roll use Angle Dimension.

Parameters:

sequence : PRSequence

Returns:

Any]

IDirection.query_pr_array(self, sequence: PRSequence) → list

Return the PR elements in an array.

Parameters:

sequence : PRSequence

Returns:

list

IDirection.query_ra_dec(self) → Tuple[Any, Any]

Get direction using the Right Ascension and Declination representation. Param Dec uses Latitude. Param RA uses Longitude.

Returns:

Any]

IDirection.query_ra_dec_array(self) → list

Return the RADec elements in an array.

Returns:

list

IDirection.query_xyz(self) → Tuple[float, float, float]

Get direction using the Cartesian representation. Params X, Y and Z are dimensionless.

Returns:

Tuple[float, float, float]

IDirection.query_xyz_array(self) → list

Return the XYZ elements in an array.

Returns:

list