Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SoCoordinateElement.h
1/*=======================================================================
2 * Copyright 1991-1996, Silicon Graphics, Inc.
3 * ALL RIGHTS RESERVED
4 *
5 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
6 * States. Use of a copyright notice is precautionary only and does not
7 * imply publication or disclosure.
8 *
9 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
10 * Use, duplication or disclosure by the Government is subject to restrictions
11 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
12 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
13 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
14 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
15 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
16 *
17 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
18 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
19 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
20 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
21 * GRAPHICS, INC.
22**=======================================================================*/
23/*=======================================================================
24** Author : Paul S. Strauss (MMM yyyy)
25**=======================================================================*/
26/*=======================================================================
27 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
28 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
29 *** ***
30 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
31 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
32 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
33 *** ***
34 *** RESTRICTED RIGHTS LEGEND ***
35 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
36 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
37 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
38 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
39 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
40 *** ***
41 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, ***
42 *** BORDEAUX, FRANCE ***
43 *** ALL RIGHTS RESERVED ***
44**=======================================================================*/
45/*=======================================================================
46** Modified by : VSG (MMM YYYY)
47**=======================================================================*/
48
49
50#ifndef _SO_COORDINATE_ELEMENT
51#define _SO_COORDINATE_ELEMENT
52
53#include <Inventor/SbBasic.h>
54#include <Inventor/SbLinear.h>
55#include <Inventor/elements/SoReplacedElement.h>
56
57
75SoEXTENDER_Documented class SoCoordinateElement : public SoReplacedElement {
76
77 SO_ELEMENT_HEADER(SoCoordinateElement);
78
79 public:
80
85 static void set3(SoState *state, SoNode *node,
86 int32_t numCoords, const SbVec3f *coords);
91 static void set4(SoState *state, SoNode *node,
92 int32_t numCoords, const SbVec4f *coords);
93
98 {return getConstElement<SoCoordinateElement>(state);}
99
103 int32_t getNum() const { return numCoords; }
104
109 SbBool is3D() const { return coordsAre3D; }
110
116 const SbVec3f & get3(int index) const;
122 const SbVec4f & get4(int index) const;
123
128 const SbVec3f * getCoord3() const { return coords3 ; }
129
134 const SbVec4f * getCoord4() const { return coords4 ; }
135
139 static SbVec3f getDefault3() { return SbVec3f(0, 0, 0); }
143 static SbVec4f getDefault4() { return SbVec4f(0, 0, 0, 1); }
144
148 virtual void print(FILE *fp) const;
149
150private:
151
153 virtual void init(SoState *state);
154
155 private:
156 // Initializes the SoCoordinateElement class
157 static void initClass();
158 static void exitClass();
159
160 // check if coord is a real user coord or the default3 value
161 bool isEmpty() const;
162
163 private:
164 int32_t numCoords;
165 const SbVec3f *coords3;
166 const SbVec4f *coords4;
167 SbBool coordsAre3D;
168
169 virtual ~SoCoordinateElement();
170
171 private:
172 // This stores a pointer to the default coordinates so that we can
173 // set "coords3" to point to them if no other values have been set.
174 static SbVec3f *defaultCoord3;
175
176 SbVec3f convert3; // To convert from 4-D to 3-D
177 SbVec4f convert4; // To convert from 3-D to 4-D
178};
179
180#endif /* _SO_COORDINATE_ELEMENT */
181
182
3D vector class.
Definition SbVec.h:932
4D vector class.
Definition SbVec.h:2214
Stores the current coordinates.
static SbVec3f getDefault3()
Returns the default 3-D coordinate.
const SbVec4f & get4(int index) const
Returns the indexed coordinate from an element as a 4-vector, converting if necessary.
const SbVec4f * getCoord4() const
Returns the array of SbVec4f without any conversion.
static const SoCoordinateElement * getInstance(SoState *state)
Returns the top (current) instance of the element in the state.
int32_t getNum() const
Returns the number of coordinate points in an instance.
static void set4(SoState *state, SoNode *node, int32_t numCoords, const SbVec4f *coords)
Sets the current coordinates in the state as 4-vectors.
SbBool is3D() const
Returns TRUE if the coordinates were specified as 3-vectors, FALSE if 4-vectors.
virtual void print(FILE *fp) const
Prints element (for debugging).
static void set3(SoState *state, SoNode *node, int32_t numCoords, const SbVec3f *coords)
Sets the current coordinates in the state as 3-vectors.
const SbVec3f * getCoord3() const
Returns the array of SbVec3f without any conversion.
static SbVec4f getDefault4()
Returns the default 4-D coordinate.
const SbVec3f & get3(int index) const
Returns the indexed coordinate from an element as a 3-vector, converting if necessary.
Abstract base class for all database nodes.
Definition SoNode.h:145
Abstract base class for each state element whose value is replaced whenever it is set.
Traversal state.
Definition SoState.h:74
int SbBool
Boolean type.
Definition SbBase.h:87