IMS2  Pre-Alpha
An Orbiter add-on to allow on-runtime construction of spacecraft from predefined modules
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
IMS_Orbiter_ModuleData Class Reference

This class contains static orbiter related properties that are common to all modules. More...

Public Member Functions

bool hadErrors ()
 
virtual void LoadFromFile (string configfilename, IMSFILE file)
 
string getMeshName ()
 
int getSize ()
 
string getConfigFileName ()
 
string getClassName ()
 
vector< IMSATTACHMENTPOINT > & getAttachmentPoints ()
 
void getPmi (VECTOR3 &OUT_pmi)
 Returns the modules principle moments of inertia in the passed VECTOR3.
 
SimpleShape * GetHullShape ()
 

Protected Attributes

std::string _configFileName
 
string _meshName
 
int _size
 
vector< IMSATTACHMENTPOINT > _attachmentPoints
 
bool _valid
 
SimpleShape * hullshape = NULL
 The vertices of the hull shape of the module, module relative.
 
VECTOR3 pmi = _V(0, 0, 0)
 

Private Member Functions

void createHullShape (HULLSHAPEDATA shapedata)
 Stores the PMI ("inertia" in the cfg) of this module. More...
 
HULLSHAPEDATA readShape (IMSFILE file)
 Reads the next line of a SHAPE block from the config file. More...
 

Detailed Description

This class contains static orbiter related properties that are common to all modules.

Config file structure

brackets are part of the actual synthax, so don't write them. Here's a little explanation of how this documentation is to be read:

parameter = <argument1> <argument2> <...> //every parameter has a name, and usually takes one or multiple arguments that are delimited by a space.
<type name> //<> brackets signify an expected argument to a parameter, its expected type and what it is for.
[Optional] //Anything in [] is optional and must not necessarily be there for a config to work.
//Or in other words, anything not in [] must be there, or there will be errors!

hull shapes

Note that transformations will always be applied in the below order, even if you don't write them in this order in the config.

[BEGIN_SHAPE
shape = <shapetype> <specific parameters> //see below for details
[offset] = <float x> <float y> <float z> //moves the shape out of the center. Use this if the mesh of your module does not have its center at 0 0 0
[scale] = <float x> <float y> <float z> //non-uniform scaling on x y and z. Use this if the basic shapes are not enough to adequately approximate
//the modules shape (flatened cylinder, oblong spheroid or somesuch).
[orientation] = <float dirx> <float diry> <float dirz> <float rotx> <float roty> <float rotz>
//rotates the shape to the given orientation, under the assumption that the original alignment is 0 0 1, 0 1 0.
//Use this to rotate a shape to fit the orientation of the mesh.
END_SHAPE]

Defines a coarse hullshape for the module. This data will be used by IMS to generate touchdown points. Note that this can get expensive for large vessels, so it makes sense to only use this parameter on modules that will make up significant parts of a vessels structures. It should not be used for small things like RCS thrusters or small propellant tanks.

valid shape parameters

shape = box <float x> <float y> <float z> //Creates a box with dimensions x y z (meters) with the center at 0 0 0
shape = cylinder <float radius> <float length> <int segments>
//Creates a cylinder aligned with the z-axis and its center at 0 0 0. radius and
//length are given in meters. segments denotes the number of radial segments.
//This must be an even number, >= 6, and I see no reason why it should ever be
//larger than 12, usually 8. You're playing with peoples framerate here!
shape = sphere <float radius> <int segments> //Creates a sphere with its center at 0 0 0. The same guidelines apply for segments
//as do for cylinders, but more so.

Example: Create a cylinder with a radius of 3 meters, a length of 12 m, offset from the center by -2 meters in the z axis.

BEGIN_SHAPE
shape = cylinder 3 12 8
offset 0 0 -2
END_SHAPE

attachment points

BEGIN_IMS_ATTACHMENT
<position> <direction> <rotation> <attachment-type> //see below for detailed description
.
.
END_IMS_ATTACHMENT

Define an arbitrary number of IMS attachment points. Attachment points will manifest on the module as docking ports, until another module Is integrated on that point, then the Dockport will vanish.

position: <float x> <float y> <float z> //The position of the attachment point in meters, relative to 0 0 0 of the mesh.
direction: <float x> <float y> <float z> //The facing ("forward") of the attachment point as a normalised vector.
rotation: <float x> <float y> <float z> //The rotation ("up") of the attachment point as a normalised vector. MUST be perpendicular to direction, or bad things will happen!
attachment-type: <string> //A string identifier for the "type" of the attachment point. Only attachment points with matching types can be assembled.

Example: Creates two attachment points on a module, one facing forward aligned with the module, the other backwards and "on its head".

BEGIN_IMS_ATTACHMENT
0 0 6 0 0 1 0 1 0 IMS2_DEFAULT
0 0 -6 0 0 -1 0 -1 0 IMS2_DEFAULT
END_IMS_ATTACHMENT

Member Function Documentation

void IMS_Orbiter_ModuleData::createHullShape ( HULLSHAPEDATA  shapedata)
private

Stores the PMI ("inertia" in the cfg) of this module.

creates the hull shape based on the parameters read from the scenario line

Parameters
shapedataThe data defining the nature of the shape.
SimpleShape* IMS_Orbiter_ModuleData::GetHullShape ( )
inline
Returns
A pointer to the hull shape of the module
HULLSHAPEDATA IMS_Orbiter_ModuleData::readShape ( IMSFILE  file)
private

Reads the next line of a SHAPE block from the config file.

Parameters
fileThe file to read from. It is implied that the last line read from the file was BEGIN_SHAPE.
Returns
The data describing the shape read from the file.
The documentation for this class was generated from the following files: