class wrapper for the object functions in SigSim library More...

Classes
struct	SL_CLOUD

Public Types
enum	ObjectBrdfEnum { ORIGINAL_PHONG = 0, SR, BECKMANN, PHONG }
	BRDF type to be used. More...
enum	SL_CLOUD_TYPE { NONE = -1, CIRROCUMULUS = 0, CIRRUS_FIBRATUS, STRATUS, CUMULUS_MEDIOCRIS, CUMULUS_CONGESTUS, CUMULUS_CONGESTUS_HI_RES, CUMULONIMBUS_CAPPILATUS, STRATOCUMULUS, TOWERING_CUMULUS }
enum	Category { defaultCategory = 0, clouds, specialeffect, diguy, water, speedtree, rdg, ship, aircraft, storm, plume, embedk, pointsource, emsig }

Public Member Functions
	ssObject ()
	constructor
virtual	~ssObject ()
	destructor
double	getThermalSpinUpTime ()
	get the thermal spin up period
bool	setThermalSpinUpTime (double hours)
	set the thermal spin up period
float *	getResponseData (ssSensor *sensor, unsigned int &numMaterials, unsigned int &numBins, unsigned int &numParameters)
	get the response data in float array form for a particular sensor useful for binding to a texture table is organized as float responseData[material][wavelength][parameter] There are 12 parameters per spectral wavelength per material.
float *	getSandfordRobertsonResponseData (ssSensor *sensor, unsigned int &numMaterials, unsigned int &numBins, unsigned int &numParameters)
	get the Sandford Robertson response data in float array form for a particular sensor
float *	getVisualData (unsigned int &numMaterials, ssSensor *sensor)
	Gets the visual band response data for a particular object.
void	getMaterialResponse (ssSensor *sensor, unsigned int matCode, float &ambient, float &emission, float &cosEmission)
	Gets the response data for a particular sensor and material code.
unsigned int	getNumberResponses ()
	gets the number of responses for an entity
unsigned int	getNumberResponseValues ()
	gets the number of response values used in the response table
unsigned int	getNumberMaterials ()
	gets the number of materials for an entity
int	getObjectType ()
	get the object type
void	setObjectType (const int type)
char *	getName ()
	get the object name
void	setName (const char *name)
int	getUniqueID ()
	get the object id.
bool	setUniqueID (int id)
	set the object id.
void	setFullResponseEnable (bool flag)
	sets the full response flag full response flag - set true for mcm textures - false for temperature maps/poly level temperatures indicates whether to place the full response in the response data or leave the emission value to be combined in the GPU
bool	getFullResponseEnable ()
	get the full response flag
void	setIncludeEmissivity (bool flag)
	set the Include Emissivity flag flag indicating whether to combine the temperature with the emissivity for the full emission respons in the response data or leave the emissivity value to be combined in the GPU
bool	getIncludeEmissivity ()
	get the Include Emissivity flag
void	setGeometryFileName (char *name)
char *	getGeometryFileName ()
void	setMaterialSystemFileName (char *name)
char *	getMaterialSystemFileName ()
void	setSCfilename (char *name)
char *	getSCfilename ()
void	setRCSfilename (char *name)
char *	getRCSfilename ()
void	setPIPfilename (char *name=NULL)
char *	getPIPfilename ()
void	setMSICfilename (char *name=NULL)
char *	getMSICfilename ()
void	setSmokeMaterialSystemFileName (char *name)
	Only applicable if this object is of a type flare.
char *	getSmokeMaterialSystemFileName ()
	Only applicable if this object is of a type flare.
void	setSmokeGeometryFileName (char *name)
	Only applicable if this object is of a type flare.
char *	getSmokeGeometryFileName ()
	Only applicable if this object is of a type flare.
void	setSmokePIPfilename (char *name=NULL)
	Only applicable if this object is of a type flare.
char *	getSmokePIPfilename ()
	Only applicable if this object is of a type flare.
void	setTrackFileName (char *name)
char *	getTrackFileName ()
void	setIndex (int i)
int	getIndex ()
void	setMaterialSet (const std::shared_ptr< ssMaterialSet > &set)
ssMaterialSet *	getMaterialSet () const
std::shared_ptr< ssMaterialSet >	getMaterialSetPtr () const
void	setGeocentricLocation (double x, double y, double z)
	set the geocentric location (meters)
void	getGeocentricLocation (double &x, double &y, double &z)
	get the geocentric location (meters)
void	setGeodeticLocation (double lat, double lon, double alt)
	set the geodetic location (degrees, degrees, meters)
void	getGeodeticLocation (double &lat, double &lon, double &alt)
	get the geodetic location (degrees, degrees, meters)
void	setOrientation (double h, double p, double r)
	set the body FRD orientation relative to local NED coords (radians)
void	getOrientation (double &h, double &p, double &r)
	get the body FRD orientation relative to local NED coords (radians)
void	setLinearVelocity (double e, double n, double u)
	set linear velocity in local ENU coords (m/s)
void	getLinearVelocity (double &e, double &n, double &u)
	get linear velocity in local ENU coords (m/s)
void	setLinearAcceleration (double e, double n, double u)
	set linear acceleration in local ENU coords (m/s2)
void	getLinearAcceleration (double &e, double &n, double &u)
	get linear acceleration in local ENU coords (m/s2)
void	setAngularVelocity (double e, double n, double u)
	set Angular velocity in local ENU coords (rad/s) Magnitude gives speed clockwise about direction.
void	getAngularVelocity (double &e, double &n, double &u)
	get Angular velocity in local ENU coords (rad/s) Magnitude gives speed clockwise about direction.
void	setAngularAcceleration (double e, double n, double u)
	set angular acceleration in local ENU coords (rad/s2) Magnitude gives acceleration clockwise about direction.
void	getAngularAcceleration (double &e, double &n, double &u)
	get angular acceleration in local ENU coords (rad/s2) Magnitude gives acceleration clockwise about direction.
void	setTimeActivated (double time=0.0)
	ssObject::setTimeActivated
double	getTimeActivated (void)
	ssObject::getTimeActivated
void	setHFTTimeLastUpdated (double time)
	ssObject::setHFTTimeLastUpdated
double	getHFTTimeLastUpdated (void)
	ssObject::getHFTTimeLastUpdated
void	setHFTTimeLLoaded (double time)
	ssObject::setHFTTimeLoaded
double	getHFTTimeLoaded (void)
	ssObject::getHFTTimeLoaded
void	ResetHFT ()
	ssObject::ResetHFT
bool	LoadHFTFile (char *infile, double current)
	ssObject::LoadHFTFile
void	UpdateHFT (double current, double dwell_secs=UPLIM)
	ssObject::UpdateHFT
void	setTrack (TRACK *track, int numTracks)
	set track
void	setTrackfileUpdate (double simTime,::ellipsoid *ellipsoid)
	set track file update
ssObject *	getPtr ()
OBJECT *	getObjectPtr ()
	get the SigSim object structure...
bool	thermalSpinUp (ssEnvironment *env)
	spins up the thermal systems for the specified duration in hours
bool	isEmatType ()
	returns true if set is being used with eigen materials
void	setEmatType (bool flag)
	set flag indicating whether the set is to be used with eigen materials.
bool	initialize (char *dataDir=NULL)
	initializes the object's special effects.
bool	update (ssEnvironment *env)
	Updates object.
void	copyIntrinsicParams (ssObject *from)
	copies all possible independent params from one ssObject to another
void	setIsDirty (bool flag)
	set all possible independent params from one ssObject to another
bool	isDirty ()
	query whether the object's parameters have changed
void	setWorldLocation (double x, double y, double z)
	Set the world location of the object.
void	getWorldLocation (double &x, double &y, double &z)
	get the world position out of ssObject
bool	isFlareObject () const
void	setObjectIntensityFactor (float intensity)
float	getObjectIntensityFactor () const
void	setBrdf (ObjectBrdfEnum v)
	set the BRDF type
ObjectBrdfEnum	getBrdf ()
	get the BRDF type
void	setRoughness (float r)
	set the roughness parameter for the BRDF
float	getRoughness ()
	get the roughness paramater for the BRDF
int	ProcessSL_CLOUD (ssEnvironment *env, double H2O_density_gpm3, double voxdim_m)
SL_CLOUD *	getSL_CLOUD (void)
void	FreeSL_CLOUDArrays (bool init)
int	AllocateSL_CLOUDArrays (long nlambda)
int	getSL_CLOUDPassbandSignature (ssSensor sensor, ssEnvironment env, double &emission, double &reflectivity, double &alpha, double &g1, double &g2, double &f)
void	setSLCloudGeometry (SL_CLOUD_TYPE type, double basealt_m, double thickness_m, double extent_m, double coverage)
int	getSLCloudGeometry (SL_CLOUD_TYPE &type, double &basealt_m, double &thickness_m, double &extent_m, double &coverage)
Category	getCategory ()
void	setCategory (Category category)
void	setOffsetTranslation (double X, double Y, double Z)
void	getOffsetTranslation (double &X, double &Y, double &Z)
void	setOffsetOrientation (double yaw, double pitch, double roll)
void	getOffsetOrientation (double &yaw, double &pitch, double &roll)

Protected Attributes
bool	m_isFlare
	flag to indicate whether this object is of a type flare or not

Private Member Functions
virtual void	updateInternal (ssEnvironment *env, bool forceUpdate)
void	setObjectPtr (OBJECT *objectPtr)
	set the SigSim object structure

Private Attributes
int	m_index
	index storage value for defining an OBJECT array
int	m_id
	unique ID for this object. Must be different than any other object
std::shared_ptr< ssMaterialSet >	m_materialSet
	material set for this object
OBJECT *	m_objectPtr
	SigSim object objects.
bool	m_objectPtr_alloc
	Indicates whether m_objectPtr was allocated by this instance.
char	m_trackFileName [SIGSIM_STRING_SIZE]
	track file name
char	m_materialSystemFileName [SIGSIM_STRING_SIZE]
	material system file name
char	m_dataDirectory [SIGSIM_STRING_SIZE]
	SigSim data directory.
char	m_geometryFilename [SIGSIM_STRING_SIZE]
	Geometry file name.
char	m_rcsFilename [SIGSIM_STRING_SIZE]
	radar cross section file name
char	m_scFilename [SIGSIM_STRING_SIZE]
	scattering center file name
char	m_pipFilename [SIGSIM_STRING_SIZE]
	Particle Input Parameters (.PIP) or plume fit (.PFIT) file name.
char	m_msicFilename [SIGSIM_STRING_SIZE]
	Point source (.MSIC) file name.
char	m_smokeGeometryFileName [SIGSIM_STRING_SIZE]
	Geometry file name for smoke that is part of a flare instance.
char	m_smokeMaterialSystemFileName [SIGSIM_STRING_SIZE]
	material system file name for smoke that is part of a flare instance
char	m_smokePipFilename [SIGSIM_STRING_SIZE]
	Particle Input Parameters file name for smoke that is part of a flare instance.
double	m_thermalSpinUp
	thermal spin up time for this object - hours
bool	m_fullResponseEnable
	flag to determine whether the full response is used for mcm texture or not for poly temperature.
bool	m_includeEmissivity
	flag to indicate whether to include the emissivity in the response table or leave it for the gpu processing.
bool	m_ematType
	flag indicating whether eigen materials are being used.
double	m_visAlpha
	Visible-band scaled particle effect alpha signature.
double	m_visReflectivity
	Visible-band scaled particle effect reflectivity signature.
double	m_visEmission
	Visible-band scaled particle effect emission signature.
bool	m_isDirty
	flag to indicate whether particle system spectral signatures need to be updated
double	m_worldXCoord
	world X position of entity
double	m_worldYCoord
	world Y position of entity
double	m_worldZCoord
	world Z position of entity
double	m_offsetTranslationX
double	m_offsetTranslationY
double	m_offsetTranslationZ
double	m_offsetOrientationYaw
double	m_offsetOrientationPitch
double	m_offsetOrientationRoll
float	m_intensityFactor
int	m_numHFT
float *	m_HFT
float	m_HFTTimeInterval
double	m_HFTLoadTime
double	m_HFTLastUpdate
float *	m_specialEffectsReponse
	response array for special effects
ObjectBrdfEnum	m_brdf
	The BRDF to use.
float	m_roughness
	BRDF roughness factor.
SL_CLOUD *	sl_cloud
Category	m_category

Static Private Attributes
static int	s_objectId

Friends
class	SigSimRT

Detailed Description

class wrapper for the object functions in SigSim library

Member Enumeration Documentation

enum ssObject::ObjectBrdfEnum

BRDF type to be used.

Enumerator:

ORIGINAL_PHONG
SR
BECKMANN
PHONG

enum ssObject::SL_CLOUD_TYPE

Enumerator:

NONE
CIRROCUMULUS
CIRRUS_FIBRATUS
STRATUS
CUMULUS_MEDIOCRIS
CUMULUS_CONGESTUS
CUMULUS_CONGESTUS_HI_RES
CUMULONIMBUS_CAPPILATUS
STRATOCUMULUS
TOWERING_CUMULUS

enum ssObject::Category

Description: Enumerates the different kinds of entities. KEEP THIS SYNCHED WITH ciEntity CATEGORY IN ciEntity.h !

Enumerator:

defaultCategory
clouds
specialeffect
diguy
water
speedtree
rdg
ship
aircraft
storm
plume
embedk
pointsource
emsig

Constructor & Destructor Documentation

ssObject::ssObject ( )

constructor

virtual ssObject::~ssObject ( )

virtual

destructor

Member Function Documentation

double ssObject::getThermalSpinUpTime ( )

get the thermal spin up period

Returns: double

bool ssObject::setThermalSpinUpTime ( double hours )

set the thermal spin up period

Parameters

hours

Returns: bool

float* ssObject::getResponseData	(	ssSensor *	sensor,
		unsigned int &	numMaterials,
		unsigned int &	numBins,
		unsigned int &	numParameters
	)

get the response data in float array form for a particular sensor useful for binding to a texture table is organized as float responseData[material][wavelength][parameter] There are 12 parameters per spectral wavelength per material.

If the full response flag is selected then the parameters are defined as: 0: ambient reflectivity - unitless 0-1 1: diffuse reflectivity - unitless 0-1 2: base emission - unitless (radiance scaled by max radiance) 3: directional solar/sun emission - unitless (radiance scaled by max radiance) 4: specular reflectivity - unitless 0-1 5: shininess - unitless 0-127 6: directional earth emission 7: directional sky emission If the full response flag is false then the parameters are defined as: 0: ambient reflectivity - unitless 0-1 1: diffuse reflectivity - unitless 0-1 2: emissivity - unitless 0-1 3: unused 4: specular reflectivity - unitless 0-1 5: shininess - unitless 0-127 6: unused 7: unused

the last 4 are the Sandford Robertson parameters 8: SR reflectance 9: SR lobe width 10: SR emissivity 11: SR grazingB

Parameters

sensor
numMaterials
numBins
numParameters

Returns: float *

float* ssObject::getSandfordRobertsonResponseData	(	ssSensor *	sensor,
		unsigned int &	numMaterials,
		unsigned int &	numBins,
		unsigned int &	numParameters
	)

get the Sandford Robertson response data in float array form for a particular sensor

Parameters

sensor
numMaterials
numBins
numParameters

Returns: float *

float* ssObject::getVisualData	(	unsigned int &	numMaterials,
		ssSensor *	sensor
	)

Gets the visual band response data for a particular object.

Parameters

numMaterials
sensor

Returns: pointer to float array suitable for use in a texture

void ssObject::getMaterialResponse	(	ssSensor *	sensor,
		unsigned int	matCode,
		float &	ambient,
		float &	emission,
		float &	cosEmission
	)

Gets the response data for a particular sensor and material code.

Parameters

sensor
matCode
ambient
emission
cosEmission

unsigned int ssObject::getNumberResponses ( )

gets the number of responses for an entity

Returns: unsigned int

unsigned int ssObject::getNumberResponseValues ( )

gets the number of response values used in the response table

Returns: unsigned int

unsigned int ssObject::getNumberMaterials ( )

gets the number of materials for an entity

Returns: unsigned int

int ssObject::getObjectType ( )

get the object type

Returns: int

void ssObject::setObjectType ( const int type )

Parameters

int

char* ssObject::getName ( )

get the object name

Returns: char

void ssObject::setName ( const char * name )

Parameters

name

int ssObject::getUniqueID ( )

get the object id.

must be unique to distiguish object

Returns: int

bool ssObject::setUniqueID ( int id )

set the object id.

must be unique to distiguish object This is normally automatically set to the next ID when the object is created, so use a number high enough to avoid duplication.

Returns

bool true if greater than current id

user needs to monitor duplication of user defined.

void ssObject::setFullResponseEnable ( bool flag )

sets the full response flag full response flag - set true for mcm textures - false for temperature maps/poly level temperatures indicates whether to place the full response in the response data or leave the emission value to be combined in the GPU

Returns: bool

bool ssObject::getFullResponseEnable ( )

get the full response flag

Returns: bool

void ssObject::setIncludeEmissivity ( bool flag )

set the Include Emissivity flag flag indicating whether to combine the temperature with the emissivity for the full emission respons in the response data or leave the emissivity value to be combined in the GPU

Returns: bool

bool ssObject::getIncludeEmissivity ( )

get the Include Emissivity flag

Returns: bool

void ssObject::setGeometryFileName ( char * name )

Parameters

name

char* ssObject::getGeometryFileName ( )

Returns: char *

void ssObject::setMaterialSystemFileName ( char * name )

Parameters

name

char* ssObject::getMaterialSystemFileName ( )

Returns: char *

void ssObject::setSCfilename ( char * name )

Parameters

name

char* ssObject::getSCfilename ( )

Returns: char *

void ssObject::setRCSfilename ( char * name )

Parameters

name

char* ssObject::getRCSfilename ( )

Returns: char *

void ssObject::setPIPfilename ( char * name = NULL )

Parameters

name

char* ssObject::getPIPfilename ( )

Returns: char *

void ssObject::setMSICfilename ( char * name = NULL )

Parameters

name

char* ssObject::getMSICfilename ( )

Returns: char *

void ssObject::setSmokeMaterialSystemFileName ( char * name )