1 /*
2 
3 -Header_File SpicePln.h ( CSPICE Plane definitions )
4 
5 -Abstract
6 
7    Perform CSPICE definitions for the SpicePlane data type.
8 
9 -Disclaimer
10 
11    THIS SOFTWARE AND ANY RELATED MATERIALS WERE CREATED BY THE
12    CALIFORNIA INSTITUTE OF TECHNOLOGY (CALTECH) UNDER A U.S.
13    GOVERNMENT CONTRACT WITH THE NATIONAL AERONAUTICS AND SPACE
14    ADMINISTRATION (NASA). THE SOFTWARE IS TECHNOLOGY AND SOFTWARE
15    PUBLICLY AVAILABLE UNDER U.S. EXPORT LAWS AND IS PROVIDED "AS-IS"
16    TO THE RECIPIENT WITHOUT WARRANTY OF ANY KIND, INCLUDING ANY
17    WARRANTIES OF PERFORMANCE OR MERCHANTABILITY OR FITNESS FOR A
18    PARTICULAR USE OR PURPOSE (AS SET FORTH IN UNITED STATES UCC
19    SECTIONS 2312-2313) OR FOR ANY PURPOSE WHATSOEVER, FOR THE
20    SOFTWARE AND RELATED MATERIALS, HOWEVER USED.
21 
22    IN NO EVENT SHALL CALTECH, ITS JET PROPULSION LABORATORY, OR NASA
23    BE LIABLE FOR ANY DAMAGES AND/OR COSTS, INCLUDING, BUT NOT
24    LIMITED TO, INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND,
25    INCLUDING ECONOMIC DAMAGE OR INJURY TO PROPERTY AND LOST PROFITS,
26    REGARDLESS OF WHETHER CALTECH, JPL, OR NASA BE ADVISED, HAVE
27    REASON TO KNOW, OR, IN FACT, SHALL KNOW OF THE POSSIBILITY.
28 
29    RECIPIENT BEARS ALL RISK RELATING TO QUALITY AND PERFORMANCE OF
30    THE SOFTWARE AND ANY RELATED MATERIALS, AND AGREES TO INDEMNIFY
31    CALTECH AND NASA FOR ALL THIRD-PARTY CLAIMS RESULTING FROM THE
32    ACTIONS OF RECIPIENT IN THE USE OF THE SOFTWARE.
33 
34 -Required_Reading
35 
36    None.
37 
38 -Particulars
39 
40    This header defines structures and typedefs that may be referenced in
41    application code that calls CSPICE Plane functions.
42 
43 
44       Structures
45       ==========
46 
47          Name                  Description
48          ----                  ----------
49 
50          SpicePlane            Structure representing a plane in 3-
51                                dimensional space.
52 
53                                The members are:
54 
55                                   normal:     Vector normal to plane.
56 
57                                   constant:   Constant of plane equation
58 
59                                               Plane =
60 
61                                               {X: <normal,X> = constant}
62 
63 
64 
65          ConstSpicePlane       A const SpicePlane.
66 
67 
68 -Literature_References
69 
70    None.
71 
72 -Author_and_Institution
73 
74    N.J. Bachman       (JPL)
75 
76 -Restrictions
77 
78    None.
79 
80 -Version
81 
82    -CSPICE Version 1.0.0, 04-MAR-1999 (NJB)
83 
84 */
85 
86 #ifndef HAVE_SPICE_PLANES
87 
88    #define HAVE_SPICE_PLANES
89 
90 
91 
92    /*
93    Plane structure:
94    */
95 
96    struct _SpicePlane
97 
98       { SpiceDouble      normal   [3];
99         SpiceDouble      constant;     };
100 
101    typedef struct _SpicePlane  SpicePlane;
102 
103    typedef const SpicePlane    ConstSpicePlane;
104 
105 #endif
106 
107