Open Inventor Reference
SoUnitsElement.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * Further, this software is distributed without any warranty that it is
16  * free of the rightful claim of any third person regarding infringement
17  * or the like. Any license provided herein, whether implied or
18  * otherwise, applies only to this software file. Patent licenses, if
19  * any, provided herein do not apply to combinations of this program with
20  * other software, or any other product whatsoever.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25  *
26  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27  * Mountain View, CA 94043, or:
28  *
29  * http://www.sgi.com
30  *
31  * For further information regarding this notice, see:
32  *
33  * http://oss.sgi.com/projects/GenInfo/NoticeExplan/
34  *
35  */
36 
37 
38 /*
39  * Copyright (C) 1990,91 Silicon Graphics, Inc.
40  *
41  _______________________________________________________________________
42  ______________ S I L I C O N G R A P H I C S I N C . ____________
43  |
44  | $Revision: 1.1.1.1 $
45  |
46  | Description:
47  | This file defines the SoUnitsElement class.
48  |
49  | Author(s) : Paul S. Strauss
50  |
51  ______________ S I L I C O N G R A P H I C S I N C . ____________
52  _______________________________________________________________________
53  */
54 
55 #ifndef _SO_UNITS_ELEMENT
56 #define _SO_UNITS_ELEMENT
57 
59 
68 
70 
72 
73  public:
75  enum Units {
89  NAUTICAL_MILES
90  };
91 
93  virtual void init(SoState *state);
94 
96  static void set(SoState *state, Units units)
97  { SoInt32Element::set(classStackIndex, state, (int32_t)units); }
98 
99 #ifndef IV_STRICT
100  static void set(SoState *state, SoNode *, Units units)
101  { set(state, units); }
102 #endif
103 
105  static Units get(SoState *state)
106  { return (Units)SoInt32Element::get(classStackIndex, state); }
107 
109  static Units getDefault() { return METERS; }
110 
112  virtual void print(FILE *fp) const;
113 
114  SoINTERNAL public:
116  static void initClass();
117 
118  protected:
119  virtual ~SoUnitsElement();
120 };
121 
122 #endif /* _SO_UNITS_ELEMENT */
#define SoEXTENDER
Provide inline template functions for abs, swap, min, max, and clamp.
Definition: SbBasic.h:154
#define SoINTERNAL
Definition: SbBasic.h:155
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition: SbSystem.h:81
signed int int32_t
Definition: SbTypeDefs.h:43
#define SO_ELEMENT_HEADER(className)
This one is for non-abstract element classes.
Definition: SoSubElement.h:112
Subclasses store a single int32_t, int, or enum value.
static int32_t get(int stackIndex, SoState *state)
Get value.
static void set(int stackIndex, SoState *state, int32_t value)
Set value.
Abstract base class for all database nodes.
Definition: SoNode.h:103
An SoState collects and holds state while traversing a scene graph.
Definition: SoState.h:82
Element that stores the current units type.
virtual void init(SoState *state)
Initializes element.
static Units getDefault()
Returns the default units.
static void set(SoState *state, SoNode *, Units units)
Units
These are the available types of units:
static Units get(SoState *state)
Returns current units from the state.
virtual ~SoUnitsElement()
static void initClass()
Initializes the SoUnitsElement class.
virtual void print(FILE *fp) const
Prints element (for debugging)
static void set(SoState *state, Units units)
Sets the current units in the state.