Coin: SoGlyph.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoGlyph.h
1#ifndef COIN_SOGLYPH_H
2#define COIN_SOGLYPH_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/SbBasic.h>
37#include <Inventor/SbBox2f.h>
38#include <Inventor/SbVec2s.h>
39#include <Inventor/misc/SoState.h>
40
41class SbName;
42class SoGlyphP;
43
44 class COIN_DLL_API SoGlyph {
45public:
46
47 enum Fonttype {
48 FONT2D = 1,
49 FONT3D = 2
50 };
51
52 void unref(void) const;
53
54 static const SoGlyph * getGlyph(const char character, const SbName & font);
55
56 const SbVec2f * getCoords(void) const;
57 const int * getFaceIndices(void) const;
58 const int * getEdgeIndices(void) const;
59 const int * getNextCWEdge(const int edgeidx) const;
60 const int * getNextCCWEdge(const int edgeidx) const;
61
62 float getWidth(void) const;
63 const SbBox2f & getBoundingBox(void) const;
64
65 static const SoGlyph * getGlyph(SoState * state,
66 const unsigned int character,
67 const SbVec2s & size,
68 const float angle);
69 SbVec2s getAdvance(void) const;
70 SbVec2s getKerning(const SoGlyph & rightglyph) const;
71 unsigned char * getBitmap(SbVec2s & size, SbVec2s & pos, const SbBool antialiased) const;
72
73protected:
74 SoGlyph(void);
75 ~SoGlyph();
76
77#if (COIN_MAJOR_VERSION == 2)
78#error Reminder: when copying this file over to Coin-2, next 3 functions
79#error must be changed back to take a non-const first argument -- to keep
80#error ABI-compatibility. Do not change any other interfaces because of this,
81#error but handle by doing work-around casting internally in SoGlyph.cpp.
82#endif
83 void setCoords(const SbVec2f * coords, int numcoords = -1);
84 void setFaceIndices(const int * indices, int numindices = -1);
85 void setEdgeIndices(const int * indices, int numindices = -1);
86
87private:
88 static void unrefGlyph(SoGlyph * glyph);
89 void setFontType(Fonttype type) const;
90
91
92 friend class SoGlyphP;
93 SoGlyphP * pimpl;
94};
95
96#endif // !COIN_SOGLYPH_H
SbBox2f
The SbBox2f class is a 2 dimensional box with floating point corner coordinates.
Definition SbBox2f.h:42
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SbVec2f
The SbVec2f class is a 2 dimensional vector with floating point coordinates.
Definition SbVec2f.h:49
SbVec2s
The SbVec2s class is a 2 dimensional vector with short integer coordinates.
Definition SbVec2s.h:51
SoGlyph
The SoGlyph class is used to generate and reuse font glyph bitmaps and outlines.
Definition SoGlyph.h:44
SoState
The SoState class manages the Coin scene graph traversal state data.
Definition SoState.h:44