srm_BaseSRF3D.h

Go to the documentation of this file.

/* SRM API
 *
 * SRM SDK Release 4.4.0 - December 7, 2009
 *
 * - SRM spec. 4.4
 *
 *
 *                             NOTICE
 * 
 * This software is provided openly and freely for use in representing and
 * interchanging environmental data & databases.
 * 
 * This software was developed for use by the United States Government with
 * unlimited rights.  The software was developed under contract
 * DASG60-02-D-0006 TO-193 by Science Applications International Corporation.
 * The software is unclassified and is deemed as Distribution A, approved
 * for Public Release.
 * 
 * Use by others is permitted only upon the ACCEPTANCE OF THE TERMS AND
 * CONDITIONS, AS STIPULATED UNDER THE FOLLOWING PROVISIONS:
 * 
 *    1. Recipient may make unlimited copies of this software and give
 *       copies to other persons or entities as long as the copies contain
 *       this NOTICE, and as long as the same copyright notices that
 *       appear on, or in, this software remain.
 * 
 *    2. Trademarks. All trademarks belong to their respective trademark
 *       holders.  Third-Party applications/software/information are
 *       copyrighted by their respective owners.
 * 
 *    3. Recipient agrees to forfeit all intellectual property and
 *       ownership rights for any version created from the modification
 *       or adaptation of this software, including versions created from
 *       the translation and/or reverse engineering of the software design.
 * 
 *    4. Transfer.  Recipient may not sell, rent, lease, or sublicense
 *       this software.  Recipient may, however enable another person
 *       or entity the rights to use this software, provided that this
 *       AGREEMENT and NOTICE is furnished along with the software and
 *       /or software system utilizing this software.
 * 
 *       All revisions, modifications, created by the Recipient, to this
 *       software and/or related technical data shall be forwarded by the
 *       Recipient to the Government at the following address:
 * 
 *         SMDC
 *         Attention SEDRIS (TO193) TPOC
 *         P.O. Box 1500
 *         Hunstville, AL  35807-3801
 * 
 *         or via electronic mail to:  se-mgmt@sedris.org
 * 
 *    5. No Warranty. This software is being delivered to you AS IS
 *       and there is no warranty, EXPRESS or IMPLIED, as to its use
 *       or performance.
 * 
 *       The RECIPIENT ASSUMES ALL RISKS, KNOWN AND UNKNOWN, OF USING
 *       THIS SOFTWARE.  The DEVELOPER EXPRESSLY DISCLAIMS, and the
 *       RECIPIENT WAIVES, ANY and ALL PERFORMANCE OR RESULTS YOU MAY
 *       OBTAIN BY USING THIS SOFTWARE OR DOCUMENTATION.  THERE IS
 *       NO WARRANTY, EXPRESS OR, IMPLIED, AS TO NON-INFRINGEMENT OF
 *       THIRD PARTY RIGHTS, MERCHANTABILITY, OR FITNESS FOR ANY
 *       PARTICULAR PURPOSE.  IN NO EVENT WILL THE DEVELOPER, THE
 *       UNITED STATES GOVERNMENT OR ANYONE ELSE ASSOCIATED WITH THE
 *       DEVELOPMENT OF THIS SOFTWARE BE HELD LIABLE FOR ANY CONSEQUENTIAL,
 *       INCIDENTAL OR SPECIAL DAMAGES, INCLUDING ANY LOST PROFITS
 *       OR LOST SAVINGS WHATSOEVER.
 *
 *
 * SRM_OTHERS_GOES_HERE
 *
 *
 * COPYRIGHT 2009, SCIENCE APPLICATIONS INTERNATIONAL CORPORATION.
 *                 ALL RIGHTS RESERVED.
 * 
 *
 */

#ifndef SRM_BASESRF3D_H_INCLUDED
#define SRM_BASESRF3D_H_INCLUDED

#if !defined(_WIN32)
#define EXPORT_DLL
#elif !defined(EXPORT_DLL)
#if defined(_LIB)
#define EXPORT_DLL
#elif defined(_USRDLL)
#define EXPORT_DLL __declspec(dllexport)
#else
#define EXPORT_DLL __declspec(dllimport)
#endif
#endif /* _WIN32 && EXPORT_DLL */

#include "srm.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef SRM_Status_Code SRM_ChangeCoordinate3DSRF
(
          SRM_Object_Reference         this_object,
    const SRM_Object_Reference         source_srf,
    const SRM_Coordinate3D            *source_coordinate,
          SRM_Coordinate3D            *target_coordinate, /* OUT */
          SRM_Coordinate_Valid_Region *region             /* OUT */
);

typedef SRM_Status_Code SRM_ChangeCoordinate3DSRFObject
(
          SRM_Object_Reference                  this_object,
    const SRM_Object_Reference                  source_srf,
    const SRM_Coordinate3D                     *source_coordinate,
    const SRM_ORM_Transformation_3D_Parameters *h_st,
          SRM_Coordinate3D                     *target_coordinate, /* OUT */
          SRM_Coordinate_Valid_Region          *region             /* OUT */
);


typedef SRM_Status_Code SRM_ChangeCoordinate3DArraySRF
(
          SRM_Object_Reference               this_object,
    const SRM_Object_Reference               source_srf,
    const SRM_Coordinate3D_Array            *source_coordinate_array,
          SRM_Coordinate3D_Array            *target_coordinate_array, /* OUT */
          SRM_Integer_Positive              *index,                   /* OUT */
          SRM_Coordinate_Valid_Region_Array *region_array             /* OUT */
);

typedef SRM_Status_Code SRM_ChangeCoordinate3DArraySRFObject
(
          SRM_Object_Reference                  this_object,
    const SRM_Object_Reference                  source_srf,
    const SRM_Coordinate3D_Array               *source_coordinate_array,
    const SRM_ORM_Transformation_3D_Parameters *h_st,
          SRM_Coordinate3D_Array               *target_coordinate_array, /* OUT */
          SRM_Integer_Positive                 *index,                   /* OUT */
          SRM_Coordinate_Valid_Region_Array    *region_array             /* OUT */
);

typedef SRM_Status_Code SRM_ChangeDirectionSRF
(
          SRM_Object_Reference         this_object,
    const SRM_Object_Reference         source_srf,
    const SRM_Direction               *source_direction,
          SRM_Direction               *target_direction, /* OUT */
          SRM_Coordinate_Valid_Region *ref_coord_region  /* OUT */
 );

typedef SRM_Status_Code SRM_ChangeDirectionSRFObject
(
          SRM_Object_Reference                  this_object,
    const SRM_Object_Reference                  source_srf,
    const SRM_Direction                        *source_direction,
    const SRM_ORM_Transformation_3D_Parameters *h_st,
          SRM_Direction                        *target_direction, /* OUT */
          SRM_Coordinate_Valid_Region          *ref_coord_region  /* OUT */
);

typedef SRM_Status_Code SRM_ChangeDirectionArraySRF
(
          SRM_Object_Reference               this_object,
    const SRM_Object_Reference               source_srf,
    const SRM_Direction_Array               *source_direction_array,
          SRM_Direction_Array               *target_direction_array, /* OUT */
          SRM_Integer_Positive              *index,                  /* OUT */
          SRM_Coordinate_Valid_Region_Array *ref_coord_region_array  /* OUT */
);

typedef SRM_Status_Code SRM_ChangeDirectionArraySRFObject
(
          SRM_Object_Reference                  this_object,
    const SRM_Object_Reference                  source_srf,
    const SRM_Direction_Array                  *source_direction_array,
    const SRM_ORM_Transformation_3D_Parameters *h_st,
          SRM_Direction_Array                  *target_direction_array, /* OUT */
          SRM_Integer_Positive                 *index,                  /* OUT */
          SRM_Coordinate_Valid_Region_Array    *ref_coord_region_array  /* OUT */
);

typedef SRM_Status_Code SRM_CreateCoordinate3D
(
    SRM_Object_Reference  this_object,
    SRM_Long_Float        first_coordinate_component,
    SRM_Long_Float        second_coordinate_component,
    SRM_Long_Float        third_coordinate_component,
    SRM_Coordinate3D     *new_coordinate                 /* OUT */
);


typedef SRM_Status_Code SRM_CreateDirection
(
          SRM_Object_Reference  this_object,
    const SRM_Coordinate3D     *reference_coordinate,
          SRM_Long_Float        first_direction_component,
          SRM_Long_Float        second_direction_component,
          SRM_Long_Float        third_direction_component,
          SRM_Direction        *new_direction                /* OUT */
);

typedef SRM_Status_Code SRM_ComputeSRFOrientation
(
          SRM_Object_Reference  this_object,
    const SRM_Object_Reference  source_srf,
    const SRM_Coordinate3D     *src_ref_loc,
    const SRM_Coordinate3D     *tgt_ref_loc,
          SRM_Object_Reference  out_ori
);


/* forward declaration of SRM_LococentricEuclidean3D */
typedef struct _SRM_LococentricEuclidean3D SRM_LococentricEuclidean3D;

typedef SRM_Status_Code SRM_CreateLococentricEuclidean3DSRF
(
          SRM_Object_Reference        this_object,
    const SRM_Coordinate3D           *lococentre,
    const SRM_Direction              *primary_axis,
    const SRM_Direction              *secondary_axis,
          SRM_LococentricEuclidean3D *new_lce3d_srf
);

typedef SRM_Status_Code SRM_TransformOrientation
(
          SRM_Object_Reference  this_object,
    const SRM_Object_Reference  source_srf,
    const SRM_Coordinate3D     *src_ref_loc,
    const SRM_Object_Reference  src_ori,
    const SRM_Coordinate3D     *tgt_ref_loc,
          SRM_Object_Reference  tgt_ori
);


typedef SRM_Status_Code SRM_TransformOrientationCommonOrigin
(
          SRM_Object_Reference         this_object,
    const SRM_Object_Reference         source_srf,
    const SRM_Coordinate3D            *src_ref_loc,
    const SRM_Object_Reference         src_ori,
          SRM_Coordinate3D            *tgt_ref_loc,
          SRM_Object_Reference         tgt_ori,
          SRM_Coordinate_Valid_Region *ref_coord_region
);


typedef SRM_Status_Code SRM_TransformVectorInBodyFrame
(
          SRM_Object_Reference  this_object,
    const SRM_Object_Reference  source_srf,
    const SRM_Coordinate3D     *src_ref_loc,
    const SRM_Object_Reference  src_ori,
    const SRM_Vector_3D        *vec,
    const SRM_Coordinate3D     *tgt_ref_loc,
          SRM_Vector_3D        *tgt_vec
);


typedef SRM_Status_Code SRM_TransformVectorInBodyFrameCommonOrigin
(
          SRM_Object_Reference         this_object,
    const SRM_Object_Reference         source_srf,
    const SRM_Coordinate3D            *src_ref_loc,
    const SRM_Object_Reference         src_ori,
    const SRM_Vector_3D               *vec,
          SRM_Coordinate3D            *tgt_ref_loc,
          SRM_Vector_3D               *tgt_vec,
          SRM_Coordinate_Valid_Region *ref_coord_region
);


typedef SRM_Status_Code SRM_TransformVector
(
          SRM_Object_Reference  this_object,
    const SRM_Object_Reference  source_srf,
    const SRM_Coordinate3D     *src_ref_loc,
    const SRM_Vector_3D        *src_vec,
    const SRM_Coordinate3D     *tgt_ref_loc,
          SRM_Vector_3D        *tgt_vec
);

typedef SRM_Status_Code SRM_TransformVectorCommonOrigin
(
          SRM_Object_Reference  this_object,
    const SRM_Object_Reference  source_srf,
    const SRM_Coordinate3D      *src_ref_loc,
    const SRM_Vector_3D         *src_vec,
          SRM_Coordinate3D      *tgt_ref_loc,
          SRM_Vector_3D         *tgt_vec,
          SRM_Coordinate_Valid_Region  *ref_coord_region   /* OUT */
);


typedef SRM_Status_Code SRM_DestroyCoordinate3D
(
    SRM_Object_Reference this_object,
    SRM_Object_Reference coordinate
);


typedef SRM_Status_Code SRM_DestroyDirection
(
    SRM_Object_Reference this_object,
    SRM_Object_Reference direction
);


typedef SRM_Status_Code SRM_EuclideanDistance3D
(
          SRM_Object_Reference  this_object,
    const SRM_Coordinate3D     *point1_coordinate,
    const SRM_Coordinate3D     *point2_coordinate,
          SRM_Long_Float       *distance           /* OUT */
);

typedef SRM_Status_Code SRM_GetCoordinate3DValues
(
       SRM_Object_Reference  this_object,
 const SRM_Coordinate3D     *coordinate,
       SRM_Long_Float       *first_coordinate_component,  /* OUT */
       SRM_Long_Float       *second_coordinate_component, /* OUT */
       SRM_Long_Float       *third_coordinate_component   /* OUT */
);


typedef SRM_Status_Code SRM_GetDirectionValues
(
          SRM_Object_Reference  this_object,
    const SRM_Direction        *direction,
          SRM_Coordinate3D     *reference_coordinate,        /* OUT */
          SRM_Long_Float       *first_direction_component,   /* OUT */
          SRM_Long_Float       *second_direction_component,  /* OUT */
          SRM_Long_Float       *third_direction_component    /* OUT */
);


typedef SRM_Status_Code SRM_GetExtendedValidRegion
(
    SRM_Object_Reference   this_object,
    SRM_Integer            component_identifier,
    SRM_Interval_Type     *interval_type,        /* OUT */
    SRM_Long_Float        *extended_lower_bound, /* OUT */
    SRM_Long_Float        *lower_bound,          /* OUT */
    SRM_Long_Float        *upper_bound,          /* OUT */
    SRM_Long_Float        *extended_upper_bound  /* OUT */
 );


typedef SRM_Status_Code SRM_GetValidRegion
(
    SRM_Object_Reference  this_object,
    SRM_Integer           component_identifier,
    SRM_Interval_Type    *interval_type,        /* OUT */
    SRM_Long_Float       *lower_bound,          /* OUT */
    SRM_Long_Float       *upper_bound           /* OUT */
 );

typedef SRM_Status_Code SRM_GetNaturalSRFSMemberCode
(
          SRM_Object_Reference   this_object,
    const SRM_Coordinate3D      *source_coordinate,
          SRM_ORM_Code           orm_code,
          SRM_RT_Code            rt_code,
          SRM_SRFS_Code          target_srfs,
          SRM_SRFS_Code_Info    *srfs_code_info    /* OUT */
);

typedef SRM_Status_Code SRM_SetCoordinate3DValues
(
    SRM_Object_Reference  this_object,
    SRM_Coordinate3D     *coordinate, /* IN / OUT */
    SRM_Long_Float        first_coordinate_component,
    SRM_Long_Float        second_coordinate_component,
    SRM_Long_Float        third_coordinate_component
);


typedef SRM_Status_Code SRM_SetExtendedValidRegion
(
    SRM_Object_Reference  this_object,
    SRM_Integer           component_identifier,
    SRM_Interval_Type     interval_type,
    SRM_Long_Float        extended_lower_bound,
    SRM_Long_Float        lower_bound,
    SRM_Long_Float        upper_bound,
    SRM_Long_Float        extended_upper_bound
 );


typedef SRM_Status_Code SRM_SetValidRegion
(
    SRM_Object_Reference this_object,
    SRM_Integer          component_identifier,
    SRM_Interval_Type    interval_type,
    SRM_Long_Float       lower_bound,
    SRM_Long_Float       upper_bound
);

#ifdef __cplusplus
}
#endif
#endif /* #ifndef/define/endif for SRM_BASESRF3D_H_INCLUDED */

---

C API	Version: 4.4 - December 7, 2009
Copyright © 2009 SEDRIS™	Docs by Doxygen 1.3.2