VectorGeometryToolPointCentralBodyIntersect

class ansys.stk.core.analysis_workbench.VectorGeometryToolPointCentralBodyIntersect

Bases: IAnalysisWorkbenchComponent, IAnalysisWorkbenchComponentTimeProperties, IVectorGeometryToolPoint

Point on central body surface along direction vector originating at source point.

Overview

Methods

set_range

Set minimum and maximum range. An exception is thrown if Minimum exceeds Maximum. An exception is thrown if UseRangeConstraint is set to true. Applicable only if the range constraint is not used.

Properties

allow_intersection_from_below	Whether intersection is computed when reference point is inside the surface. Applicable when the surface is not defined by terrain.
altitude	An altitude.
central_body	Central body.
direction_vector	A direction vector. Can be any vector from VGT.
intersection_surface	An intersection surface.
maximum_range	A maximum range. An exception is thrown if the value is less than the MinimumRange. Applicable only if the range constraint is not used.
minimum_range	A minimum range. An exception is thrown if the value exceeds the MaximumRange. Applicable only if the range constraint is not used.
reference_point	A reference point. Can be any point from VGT.
use_maximum_range	Whether the maximum range is used. Applicable only if the range constraint is not used.
use_minimum_range	Whether the minimum range is used. Applicable only if the range constraint is not used.
use_range_constraint	Whether to use range constraint.

Import detail

from ansys.stk.core.analysis_workbench import VectorGeometryToolPointCentralBodyIntersect

Property detail

property VectorGeometryToolPointCentralBodyIntersect.allow_intersection_from_below: bool

Whether intersection is computed when reference point is inside the surface. Applicable when the surface is not defined by terrain.

property VectorGeometryToolPointCentralBodyIntersect.altitude: float

An altitude.

property VectorGeometryToolPointCentralBodyIntersect.central_body: str

Central body.

property VectorGeometryToolPointCentralBodyIntersect.direction_vector: IVectorGeometryToolVector

A direction vector. Can be any vector from VGT.

property VectorGeometryToolPointCentralBodyIntersect.intersection_surface: IntersectionSurfaceType

An intersection surface.

property VectorGeometryToolPointCentralBodyIntersect.maximum_range: float

A maximum range. An exception is thrown if the value is less than the MinimumRange. Applicable only if the range constraint is not used.

property VectorGeometryToolPointCentralBodyIntersect.minimum_range: float

A minimum range. An exception is thrown if the value exceeds the MaximumRange. Applicable only if the range constraint is not used.

property VectorGeometryToolPointCentralBodyIntersect.reference_point: IVectorGeometryToolPoint

A reference point. Can be any point from VGT.

property VectorGeometryToolPointCentralBodyIntersect.use_maximum_range: bool

Whether the maximum range is used. Applicable only if the range constraint is not used.

property VectorGeometryToolPointCentralBodyIntersect.use_minimum_range: bool

Whether the minimum range is used. Applicable only if the range constraint is not used.

property VectorGeometryToolPointCentralBodyIntersect.use_range_constraint: bool

Whether to use range constraint.

Method detail

VectorGeometryToolPointCentralBodyIntersect.set_range(self, minimum: float, maximum: float) → None

Set minimum and maximum range. An exception is thrown if Minimum exceeds Maximum. An exception is thrown if UseRangeConstraint is set to true. Applicable only if the range constraint is not used.

Parameters:

minimum : float

maximum : float

Returns:

None