Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SoTextDetail.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 : Thaddeus Beier (MMM yyyy)
25** Modified by : Dave Immel (MMM yyyy)
26** Modified by : Howard Look (MMM yyyy)
27**=======================================================================*/
28/*=======================================================================
29 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
30 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
31 *** ***
32 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
33 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
34 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
35 *** ***
36 *** RESTRICTED RIGHTS LEGEND ***
37 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
38 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
39 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
40 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
41 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
42 *** ***
43 *** COPYRIGHT (C) 1996-2018 BY FEI S.A.S, ***
44 *** BORDEAUX, FRANCE ***
45 *** ALL RIGHTS RESERVED ***
46**=======================================================================*/
47/*=======================================================================
48** Modified by : VSG (MMM YYYY)
49**=======================================================================*/
50
51
52#ifndef _SO_TEXT_DETAIL_
53#define _SO_TEXT_DETAIL_
54
55#include <Inventor/SbBox.h>
56#include <Inventor/details/SoSubDetail.h>
57#include <Inventor/nodes/SoText3.h>
58
60//
61// Class: SoTextDetail
62//
63// Detail about a shape representing text.
64//
66
86class SoTextDetail : public SoDetail {
87
88 SO_DETAIL_HEADER(SoTextDetail);
89
90 public:
98 virtual ~SoTextDetail();
99
104 int32_t getStringIndex() const { return stringIndex; }
105
111 int32_t getCharacterIndex() const { return charIndex; }
112
116 SoText3::Part getPart() const { return part; }
117
119 virtual SoDetail* copy() const;
120
121 private:
122 // For Text3, this sets which part is picked:
123 void setPart(SoText3::Part p) { part = p; }
124
125 // These set the string and character indices:
126 void setStringIndex(int32_t i) { stringIndex = i; }
127 void setCharacterIndex(int32_t i) { charIndex = i; }
128
132 void setStringIndex(long i) // System long
133 { setStringIndex((int32_t) i); }
134
138 void setCharacterIndex(long i) // System long
139 { setCharacterIndex((int32_t) i); }
140
141 private:
142 static void initClass();
143 static void exitClass();
144
145 private:
146 int32_t stringIndex, charIndex;
147 SoText3::Part part;
148
149};
150
151#endif /* _SO_TEXT_DETAIL_ */
152
Base class for describing detail information about a shape node.
Definition SoDetail.h:99
Part
Text3 part values.
Definition SoText3.h:232
Stores detail information about a text node.
SoText3::Part getPart() const
For SoText3, this returns which part was picked or generated.
virtual ~SoTextDetail()
Destructor.
virtual SoDetail * copy() const
Returns an instance that is a copy of this instance.
int32_t getCharacterIndex() const
Returns the index of the relevant character within the string.
SoTextDetail()
Constructor.
int32_t getStringIndex() const
Returns the index of the relevant string within a multiple-value string field of a text node.