Struct VesselContext

#[repr(C)]
pub struct VesselContext { /* private fields */ }

Rust interface to the VESSELx abstract classes in Orbiter SDK

Implementations

impl VesselContext

pub fn Local2Rel(&self, local: &VECTOR3, rel: &mut VECTOR3)

Performs a transformation from local vessel coordinates to the ecliptic frame centered at the vessel’s reference body

impl VesselContext

pub fn Global2Local(&self, global: &VECTOR3, local: &mut VECTOR3)

Performs a transformation from global (ecliptic) to local vessel coordinates

impl VesselContext

pub fn Local2Global(&self, local: &VECTOR3, global: &mut VECTOR3)

Performs a transformation from local vessel to global (ecliptic) coordinates

impl VesselContext

pub fn SetSize(&self, size: f64)

Set the vessel’s mean radius

The size should correspond to the vessel’s visual representation, for example the mesh used to show the vessel in the simulation window. The size parameter is used by Orbiter to determine the camera distance at which the vessel is within visual range of the observer camera. It is also used for calculating various physical parameters. If SetSize is not called during the vessel setup, the value from the Size entry in the vessel’s configuration file is used.

impl VesselContext

pub fn SetPMI(&self, pmi: &VECTOR3)

Set the vessel’s mass-normalised principal moments of inertia (PMI)

impl VesselContext

pub fn SetEmptyMass(&self, empty_mass: f64)

Set the vessel’s empty mass (excluding propellants)

impl VesselContext

pub fn SetCameraOffset(&self, camera_offset: &VECTOR3)

Set the camera position for internal (cockpit) view.

Arguments

• camera_offset - Camera offset in vessel coordinates

impl VesselContext

pub fn SetTouchdownPoints(&self, pt1: &VECTOR3, pt2: &VECTOR3, pt3: &VECTOR3)

Defines the three points defining the vessel’s ground contact plane

impl VesselContext

pub fn SetThrusterDir(&self, th: THRUSTER_HANDLE, dir: &VECTOR3)

Reset the force direction of a thruster

impl VesselContext

pub fn SetThrusterLevel(&self, th: THRUSTER_HANDLE, level: f64)

Set thrust level for a thruster

impl VesselContext

pub fn SetThrusterLevel_SingleStep(&self, th: THRUSTER_HANDLE, level: f64)

Set the thrust level of a thruster for the current time step only

impl VesselContext

pub fn AddMesh(&self, mesh_name: String)

Load a mesh definition for the vessel from a file

impl VesselContext

pub fn AddMeshWithOffset(&self, mesh_name: String, ofs: &VECTOR3)

Load a mesh definition for the vessel from a file displaced by offset ofs

Arguments

• mesh_name - name of the mesh file (without extension)
• ofs - a displacement vector which describes the offset of the mesh origin against the vessel origin

impl VesselContext

pub fn AddExhaust(&self, th: THRUSTER_HANDLE, lscale: f64, wscale: f64) -> usize

Add an exhaust render definition for a thruster

impl VesselContext

pub fn CreatePropellantResource(&self, mass: f64) -> PROPELLANT_HANDLE

Create a new propellant resource (“fuel tank”)

Propellant resources are a component of the vessel’s propulsion system. They can hold propellants and distribute them to connected engines to generate thrust

impl VesselContext

pub fn CreateThruster( &self, pos: &VECTOR3, dir: &VECTOR3, maxth0: f64, ph: PROPELLANT_HANDLE, isp: f64, ) -> THRUSTER_HANDLE

Add a logical thruster definition for the vessel

impl VesselContext

pub fn CreateThrusterGroup( &self, thrusters: &[THRUSTER_HANDLE], thgroup_type: THGROUP_TYPE, ) -> THGROUP_HANDLE

Combine thrusters into a logical thruster group

impl VesselContext

pub fn ClearMeshes(&self)

Remove all mesh definitions for the vessel

impl VesselContext

pub fn GetName(&self) -> &str

Returns the vessel’s name

impl VesselContext

pub fn GetStatus(&self, status: &mut VESSELSTATUS)

Returns the vessel’s current status parameters in a [VesselStatus] structure

impl VesselContext

pub fn GetPropellantMass(&self, ph: PROPELLANT_HANDLE) -> f64

Returns the current mass of a propellant resource specified by ph

impl VesselContext

pub fn GetAngularVel(&self, a_vel: &mut VECTOR3)

Get angular velocity (in rad/s) of the spacecraft around its principal axes and store it in a_vel

impl VesselContext

pub fn GetAirspeedVector( &self, ref_frame: REFFRAME, airspeed: &mut VECTOR3, ) -> bool

Returns the vessel’s true “airspeed” vector

This method returns the true airspeed vector in the requested frame of reference. The ground airvector is defined as the vessel’s velocity vector with respect to the surrounding freestream air flow. If the vessel is not within an a planetary atmosphere, the returned vector is equal to the groundspeed vector

impl VesselContext

pub fn GetThrustVector(&self, thrust_vec: &mut VECTOR3) -> bool

Returns thrust force vector in local vessel coordinates

impl VesselContext

pub fn GetTotalPropellantMass(&self) -> f64

Returns the vessel’s current total propellant mass

impl VesselContext

pub fn GetThrusterGroupLevelByType(&self, thgroup_type: THGROUP_TYPE) -> f64

Returns the mean thrust level for a default thruster group type

impl VesselContext

pub fn GetThrusterGroupLevel(&self, th: THGROUP_HANDLE) -> f64

Returns the mean thrust level for a default thruster group specified by th

impl VesselContext

pub fn GroundContact(&self) -> bool

Returns a flag indicating contact with a planetary surface

impl VesselContext

pub fn GetSurfaceRef(&self) -> OBJHANDLE

Returns a handle to the surface reference object (planet or moon)

impl VesselContext

pub fn GetSurfaceElevation(&self) -> f64

Returns the elevation of the surface at the vessel’s current longitude/latitude above the reference radius

impl VesselContext

pub fn GetAltitude(&self) -> f64

Returns altitude above mean ellipsoid

impl VesselContext

pub fn GetRelativeVel(&self, href: OBJHANDLE, rel_vel: &mut VECTOR3)

Returns the vessel’s current velocity relative to another object

Results are returned in the ecliptic frame (ecliptic and equinox of J2000.0).

impl VesselContext

pub unsafe fn ParseScenarioLineEx(&self, line: *mut c_char, status: *mut c_void)

Pass a line read from a scenario file to Orbiter for default processing

Trait Implementations

impl Debug for VesselContext

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ExternType for VesselContext

type Kind = Opaque

Either cxx::kind::Opaque or cxx::kind::Trivial.

type Id

A type-level representation of the type’s C++ namespace and type name.