ssObject.h

Go to the documentation of this file.

// Copyright JRM Enterprises, Inc. 2004 - 2012
// All rights reserved.
//
// This code is the intellectual property of JRM Enterprises, Inc.
// It may not be used or released as source or compiled binary form
// without the prior written consent of JRM Enterprises, Inc.
//
// Original Author:     Eric Olson     Date: May 2004

#ifndef _ssObject_
#define _ssObject_

#include "ssMaterialSet.h"
#include "ssdllexport.h"


#include "CTDR-CPDR.h"
#include "Objects.h"


#define DIRTY_VELDIF_MPS 1.0
#define DIRTY_ALTDIF_M 1000.0

// class: ssObject
class SIGSIMRT_API ssObject 
{
public:
    typedef enum
    {
        ORIGINAL_PHONG=0,  
        SR,
      BECKMANN,
      PHONG
    } ObjectBrdfEnum;


    //   ssObject
    ssObject();

    //~ssObject
    virtual ~ssObject();

    //getThermalSpinUpTime
    double getThermalSpinUpTime();

    //setThermalSpinUpTime
    bool setThermalSpinUpTime(double hours);

    //*getResponseData
    float *getResponseData(ssSensor *sensor, unsigned int &numMaterials, unsigned int &numBins, unsigned int &numParameters);
    //*getSandfordRobertsonResponseData
    float *getSandfordRobertsonResponseData(ssSensor *sensor, unsigned int &numMaterials, unsigned int &numBins, unsigned int &numParameters);

    // getVisualdata
    float *getVisualData(unsigned int &numMaterials, ssSensor *sensor);

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

    // getRCS
    double getRCS(ssSensor *sensor, ssEnvironment *env);

    //getNumberResponses
    unsigned int getNumberResponses();

    // getNumberResponseValues
    //
    unsigned int getNumberResponseValues();

    //getNumberMaterials
    unsigned int getNumberMaterials();

   //*getObjectType
   int getObjectType();

   //setObjectType
   void setObjectType(const int type);

    //*getName
    char *getName();

    //setName
    void setName(const char *name);

    //getUniqueID
    int getUniqueID();

    //setUniqueID
    bool setUniqueID(int id);

    //*setFullResponseEnable
    void setFullResponseEnable(bool flag);

    //*getFullResponseEnable
    bool getFullResponseEnable();

    //*setIncludeEmissivity
    void setIncludeEmissivity(bool flag);

    //*getIncludeEmissivity
    bool getIncludeEmissivity();

    //setMaterialSystemFileName
    void setMaterialSystemFileName(char *name);

    //getMaterialSystemFileName
    char *getMaterialSystemFileName();

    //setSCfilename
    void setSCfilename(char *name);

    //getSCfilename
    char *getSCfilename();

    //setRCSfilename
    void setRCSfilename(char *name);

    //getRCSfilename
    char *getRCSfilename();

    //setPIPfilename
    void setPIPfilename(char *name = NULL);

    //getPIPfilename
    char *getPIPfilename();

    //setTrackFileName
    void setTrackFileName(char *name);

    //getTrackFileName
    char *getTrackFileName();

    //setIndex
    void setIndex(int i);
    //getIndex
    int getIndex();

    //*setMaterialSet
    void setMaterialSet(ssMaterialSet *set);

    //*getMaterialSet
    ssMaterialSet *getMaterialSet();


    //setGeocentricLocation
    void setGeocentricLocation(
        double x, 
        double y, 
        double z);

    //getGeocentricLocation
    void getGeocentricLocation(
        double &x, 
        double &y, 
        double &z);

    //setGeodeticLocation
    void setGeodeticLocation(
        double lat, 
        double lon, 
        double alt);

    //getGeodeticLocation
    void getGeodeticLocation(
        double &lat, 
        double &lon, 
        double &alt);

    //setOrientation
    void setOrientation(
        double h, 
        double p, 
        double r);

    //getOrientation
    void getOrientation(
        double &h, 
        double &p, 
        double &r);


    //setLinearVelocity
    void setLinearVelocity(double e, 
        double n, 
        double u);

    //getLinearVelocity
    void getLinearVelocity(double &e, 
        double &n, 
        double &u);

    //setLinearAcceleration
    void setLinearAcceleration(double e, 
        double n, 
        double u);

    //getLinearAcceleration
    void getLinearAcceleration(double &e, 
        double &n, 
        double &u);

    //setAngularVelocity
    void setAngularVelocity(double e, 
        double n, 
        double u);

    //getAngularVelocity
    void getAngularVelocity(double &e, 
        double &n, 
        double &u);

    //setAngularAcceleration
    void setAngularAcceleration(double e, 
        double n, 
        double u);

    //getAngularAcceleration
    void getAngularAcceleration(double &e, 
        double &n, 
        double &u);

    // setTrack
    void setTrack(TRACK *track, int numTracks);

    // setTrackfileUpdate
    void setTrackfileUpdate(double simTime, ::ellipsoid *ellipsoid);

    //* getPlumeRadianceMap
    PLUME_RADIANCE_MAP *getPlumeRadianceMap();

    //*getObjectPtr
    OBJECT *getObjectPtr();

    //thermalSpinUp
    bool thermalSpinUp(ssEnvironment *env);

    //isEmatType
    bool isEmatType() ;

    //setEmatType
    void setEmatType(bool flag);

    //initialize
    bool initialize(char *dataDir = NULL);

    // update
    bool update(ssEnvironment *env);

    // loadRCSFile
    bool loadRCSFile();

    // getScaledEffectBandSignature
    bool getScaledEffectBandSignature(double &emission, double &reflectivity, double &alpha, int &processpath, ssEnvironment *env, ssSensor *sensor);

    // getScaledEffectSpectralSignature
    float *getScaledEffectSpectralSignature(int &processpath, int &numSensorWaveLengths, int &reponseWidth, ssEnvironment *env, ssSensor *sensor);

    // updateVisibleScaledEffectBandSignature
    void updateVisibleScaledEffectBandSignature(ssEnvironment *env);

    // getVisibleScaledEffectBandSignature
    void getVisibleScaledEffectBandSignature(double &emission, double &reflectivity, double &alpha);

    // setVisibleScaledEffectBandSignature
    void setVisibleScaledEffectBandSignature(double emission, double reflectivity, double alpha);


    // copyIntrinsicParams
    void copyIntrinsicParams(ssObject *from);


    // setIsDirty
    void setIsDirty(bool flag);

    // isDirty
    bool isDirty();

    //setWorldLocation
    void setWorldLocation(double x, double y, double z);

    //getWorldLocation
    void getWorldLocation(double& x, double& y, double& z);

    // Methods for SR support
    void setBrdf (ObjectBrdfEnum v);
    ObjectBrdfEnum getBrdf ();
    void setRoughness (float r);
    float getRoughness ();

private:


    //setObjectPtr
    void setObjectPtr(OBJECT *objectPtr);

    int m_index;

    int m_id;
    ssMaterialSet *m_materialSet;

    OBJECT *m_objectPtr;
    bool m_objectPtr_alloc;

    char m_trackFileName[SIGSIM_STRING_SIZE];
    char m_materialSystemFileName[SIGSIM_STRING_SIZE];

    char m_dataDirectory[SIGSIM_STRING_SIZE];
    char m_rcsFilename[SIGSIM_STRING_SIZE];
    char m_scFilename[SIGSIM_STRING_SIZE];
    char m_pipFilename[SIGSIM_STRING_SIZE];

    double m_thermalSpinUp;
    bool m_fullResponseEnable;
    bool m_includeEmissivity;
    // For generating the unique id
    bool m_ematType;

   double m_visAlpha;
   double m_visReflectivity;
   double m_visEmission;

   bool m_isDirty;

   double m_worldXCoord; 
   double m_worldYCoord; 
   double m_worldZCoord; 

   float *m_specialEffectsReponse; 

    ObjectBrdfEnum m_brdf;
    float m_roughness;

    static int s_objectId;

    friend class SigSimRT;
    friend class ssRadar;

};

#endif // _ssObject_