Main Page | Alphabetical List | Compound List | File List | Compound Members | File Members

srm_BaseSRFwithTangentPlaneSurface.h File Reference

#include "srm.h"

Go to the source code of this file.

Defines

#define EXPORT_DLL

Typedefs

typedef SRM_Status_Code SRM_AssociateSurfaceCoordinateTPS (SRM_Object_Reference this_object, const SRM_Coordinate3D *coordinate, SRM_SurfaceCoordinate *on_surface_coordinate)
typedef SRM_Status_Code SRM_CreateSurfaceCoordinateTPS (SRM_Object_Reference this_object, SRM_Long_Float first_coordinate_component, SRM_Long_Float second_coordinate_component, SRM_SurfaceCoordinate *new_coordinate)
typedef SRM_Status_Code SRM_DestroySurfaceCoordinateTPS (SRM_Object_Reference this_object, SRM_Object_Reference coordinate)
typedef SRM_Status_Code SRM_EuclideanDistanceTPS (SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *point1_coordinate, const SRM_SurfaceCoordinate *point2_coordinate, SRM_Long_Float *distance)
typedef SRM_Status_Code SRM_GetSurfaceCoordinateValuesTPS (SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *coordinate, SRM_Long_Float *first_coordinate_component, SRM_Long_Float *second_coordinate_component)
typedef SRM_Status_Code SRM_PromoteSurfaceCoordinateTPS (SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Coordinate3D *coordinate)

Define Documentation

#define EXPORT_DLL
 

Definition at line 19 of file srm_BaseSRFwithTangentPlaneSurface.h.

Typedef Documentation

typedef SRM_Status_Code SRM_AssociateSurfaceCoordinateTPS( SRM_Object_Reference this_object, const SRM_Coordinate3D *coordinate, SRM_SurfaceCoordinate *on_surface_coordinate )
 

This is the Associate Surface Coordinate for Tangent Place Surface

Parameters:
this_object in: this SRF object
coordinate in: surface coordinate
on_surface_coordinate out: resulting in a surface coordinate
Returns:
a status code

Definition at line 43 of file srm_BaseSRFwithTangentPlaneSurface.h.

typedef SRM_Status_Code SRM_CreateSurfaceCoordinateTPS( SRM_Object_Reference this_object, SRM_Long_Float first_coordinate_component, SRM_Long_Float second_coordinate_component, SRM_SurfaceCoordinate *new_coordinate )
 

This creates the Surface Coordinate for the Tangent Place Surface

Parameters:
this_object in: this SRF object
first_coordinate_component in: this is the first component
second_coordinate_component in: this is the second component
new_coordinate out: resulting in a new tangent plane coordinate
Returns:
a status code

Definition at line 57 of file srm_BaseSRFwithTangentPlaneSurface.h.

typedef SRM_Status_Code SRM_DestroySurfaceCoordinateTPS( SRM_Object_Reference this_object, SRM_Object_Reference coordinate )
 

This destroys the Tangent Place Surface coordinate

Parameters:
this_object in: this SRF object
coordinate in: coordinate to be destroyed
Returns:
a status code

Definition at line 70 of file srm_BaseSRFwithTangentPlaneSurface.h.

typedef SRM_Status_Code SRM_EuclideanDistanceTPS( SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *point1_coordinate, const SRM_SurfaceCoordinate *point2_coordinate, SRM_Long_Float *distance )
 

This is the Euclidean Distance for the Tangent Plane Surface

Parameters:
this_object in: this SRF object
point1_coordinate in: surface coordinate for the source
point2_coordinate in: surface coordinate for the target
distance out: distance between the two coordinates
Returns:
a status code

Definition at line 83 of file srm_BaseSRFwithTangentPlaneSurface.h.

typedef SRM_Status_Code SRM_GetSurfaceCoordinateValuesTPS( SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *coordinate, SRM_Long_Float *first_coordinate_component, SRM_Long_Float *second_coordinate_component )
 

This gets the Surface Coordinate values for the Tangent Place Surface

Parameters:
this_object in: th SRF object
point1_coordinate in: surface coordinate for the source
point2_coordinate in: surface coordinate for the target
distance out: distance between the two coordinates
Returns:
a status code

Definition at line 98 of file srm_BaseSRFwithTangentPlaneSurface.h.

typedef SRM_Status_Code SRM_PromoteSurfaceCoordinateTPS( SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Coordinate3D *coordinate )
 

This is the Promote Surface Coordinate for the Tangent Place Surface

Parameters:
this_object in: this SRF object
surface_coordinate in: surface coordinate for the source
point2_coordinate in: surface coordinate for the target
coordinate out: resulting in a coordinate
Returns:
a status code

Definition at line 113 of file srm_BaseSRFwithTangentPlaneSurface.h.

C API Version: 4.1.1 - 14 Jun 2007
Copyright © 2007 SEDRIS™ Docs by Doxygen 1.3.2