OpenSceneGraph/include/osgText/Font3D

58 lines
1.8 KiB
Plaintext
Raw Normal View History

From David Callu, "Problem: osgText::Text and osgText::Text3D use the same font file. The first really load the file and obtain an osgText::Font object, the second use the cache created during the first load of the font file, and so obtain an osgText::Font object instead of osgText::Font3D object. To obtain an osgText::Font3D object, osgText::Text3D call osgDB::readObjectFile(...) with an option to specify the plugin we want an osgText::Font3D instead of osgText::Font. Generalised Problem: In osgDB::Registry, loaded file cache is referenced by the name of this file, so if I load a file with some options, and the cache already contain object for this filename, I obtain an object potentially not loaded with my options. Behaviours: Cache management is delegate to osgDB::Registry, but cache coherence (load a file with option then reuse it, deactivate the cache when load a specific file or don't cached the loaded file) is user's responsibility. Text3D solution: Postfix the font file name by .text3d or something similar and then have the freetype plugin return osgText::Font3D when it detects this. This operation is done by osgText::readFont3DFile() which unsure the filename have .text3d as extension. This is totaly transparent for user, and backward compatible. BTW, I fix the bug about the Normal of 3D text. Currently, the front and wall face have the same normal (0,0,1) in the Text3D object coordinate. Now the wall face have its own normal array computed by the plugin. BTW 2, I implement - void Text3D::accept(osg::Drawable::ConstAttributeFunctor& af) const - void Text3D::accept(osg::PrimitiveFunctor& pf) const so now statistics are well reported. "
2009-03-10 18:56:00 +08:00
/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
*
From David Callu, "Problem: osgText::Text and osgText::Text3D use the same font file. The first really load the file and obtain an osgText::Font object, the second use the cache created during the first load of the font file, and so obtain an osgText::Font object instead of osgText::Font3D object. To obtain an osgText::Font3D object, osgText::Text3D call osgDB::readObjectFile(...) with an option to specify the plugin we want an osgText::Font3D instead of osgText::Font. Generalised Problem: In osgDB::Registry, loaded file cache is referenced by the name of this file, so if I load a file with some options, and the cache already contain object for this filename, I obtain an object potentially not loaded with my options. Behaviours: Cache management is delegate to osgDB::Registry, but cache coherence (load a file with option then reuse it, deactivate the cache when load a specific file or don't cached the loaded file) is user's responsibility. Text3D solution: Postfix the font file name by .text3d or something similar and then have the freetype plugin return osgText::Font3D when it detects this. This operation is done by osgText::readFont3DFile() which unsure the filename have .text3d as extension. This is totaly transparent for user, and backward compatible. BTW, I fix the bug about the Normal of 3D text. Currently, the front and wall face have the same normal (0,0,1) in the Text3D object coordinate. Now the wall face have its own normal array computed by the plugin. BTW 2, I implement - void Text3D::accept(osg::Drawable::ConstAttributeFunctor& af) const - void Text3D::accept(osg::PrimitiveFunctor& pf) const so now statistics are well reported. "
2009-03-10 18:56:00 +08:00
* This library is open source and may be redistributed and/or modified under
* the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
* (at your option) any later version. The full license is in LICENSE file
* included with this distribution, and on the openscenegraph.org website.
From David Callu, "Problem: osgText::Text and osgText::Text3D use the same font file. The first really load the file and obtain an osgText::Font object, the second use the cache created during the first load of the font file, and so obtain an osgText::Font object instead of osgText::Font3D object. To obtain an osgText::Font3D object, osgText::Text3D call osgDB::readObjectFile(...) with an option to specify the plugin we want an osgText::Font3D instead of osgText::Font. Generalised Problem: In osgDB::Registry, loaded file cache is referenced by the name of this file, so if I load a file with some options, and the cache already contain object for this filename, I obtain an object potentially not loaded with my options. Behaviours: Cache management is delegate to osgDB::Registry, but cache coherence (load a file with option then reuse it, deactivate the cache when load a specific file or don't cached the loaded file) is user's responsibility. Text3D solution: Postfix the font file name by .text3d or something similar and then have the freetype plugin return osgText::Font3D when it detects this. This operation is done by osgText::readFont3DFile() which unsure the filename have .text3d as extension. This is totaly transparent for user, and backward compatible. BTW, I fix the bug about the Normal of 3D text. Currently, the front and wall face have the same normal (0,0,1) in the Text3D object coordinate. Now the wall face have its own normal array computed by the plugin. BTW 2, I implement - void Text3D::accept(osg::Drawable::ConstAttributeFunctor& af) const - void Text3D::accept(osg::PrimitiveFunctor& pf) const so now statistics are well reported. "
2009-03-10 18:56:00 +08:00
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
From David Callu, "Problem: osgText::Text and osgText::Text3D use the same font file. The first really load the file and obtain an osgText::Font object, the second use the cache created during the first load of the font file, and so obtain an osgText::Font object instead of osgText::Font3D object. To obtain an osgText::Font3D object, osgText::Text3D call osgDB::readObjectFile(...) with an option to specify the plugin we want an osgText::Font3D instead of osgText::Font. Generalised Problem: In osgDB::Registry, loaded file cache is referenced by the name of this file, so if I load a file with some options, and the cache already contain object for this filename, I obtain an object potentially not loaded with my options. Behaviours: Cache management is delegate to osgDB::Registry, but cache coherence (load a file with option then reuse it, deactivate the cache when load a specific file or don't cached the loaded file) is user's responsibility. Text3D solution: Postfix the font file name by .text3d or something similar and then have the freetype plugin return osgText::Font3D when it detects this. This operation is done by osgText::readFont3DFile() which unsure the filename have .text3d as extension. This is totaly transparent for user, and backward compatible. BTW, I fix the bug about the Normal of 3D text. Currently, the front and wall face have the same normal (0,0,1) in the Text3D object coordinate. Now the wall face have its own normal array computed by the plugin. BTW 2, I implement - void Text3D::accept(osg::Drawable::ConstAttributeFunctor& af) const - void Text3D::accept(osg::PrimitiveFunctor& pf) const so now statistics are well reported. "
2009-03-10 18:56:00 +08:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* OpenSceneGraph Public License for more details.
*/
#ifndef OSGTEXT_FONT3D
#define OSGTEXT_FONT3D 1
#include <osgText/Font>
namespace osgText {
typedef Font Font3D;
Introduced CMake option OSG_PROVIDE_READFILE option that defaults to ON, but when switched to OFF disables the building of the osgDB::read*File() methods, forcing users to use osgDB::readRef*File() methods. The later is preferable as it closes a potential threading bug when using paging databases in conjunction with the osgDB::Registry Object Cache. This threading bug occurs when one thread gets an object from the Cache via an osgDB::read*File() call where only a pointer to the object is passed back, so taking a reference to the object is delayed till it gets reassigned to a ref_ptr<>, but at the same time another thread calls a flush of the Object Cache deleting this object as it's referenceCount is now zero. Using osgDB::readREf*File() makes sure the a ref_ptr<> is passed back and the referenceCount never goes to zero. To ensure the OSG builds when OSG_PROVIDE_READFILE is to OFF the many cases of osgDB::read*File() usage had to be replaced with a ref_ptr<> osgDB::readRef*File() usage. The avoid this change causing lots of other client code to be rewritten to handle the use of ref_ptr<> in place of C pointer I introduced a serious of templte methods in various class to adapt ref_ptr<> to the underly C pointer to be passed to old OSG API's, example of this is found in include/osg/Group: bool addChild(Node* child); // old method which can only be used with a Node* tempalte<class T> bool addChild(const osg::ref_ptr<T>& child) { return addChild(child.get()); } // adapter template method These changes together cover 149 modified files, so it's a large submission. This extent of changes are warrent to make use of the Object Cache and multi-threaded loaded more robust. git-svn-id: http://svn.openscenegraph.org/osg/OpenSceneGraph/branches/OpenSceneGraph-3.4@15165 16af8721-9629-0410-8352-f15c8da7e697
2015-10-22 22:14:53 +08:00
#ifdef OSG_PROVIDE_READFILE
2010-09-22 17:50:07 +08:00
/** deprecated, use readFontFile() instead.*/
inline Font* readFont3DFile(const std::string& filename, const osgDB::ReaderWriter::Options* userOptions = 0)
{
return readFontFile(filename,userOptions);
}
2010-09-22 17:50:07 +08:00
/** deprecated, use readFontStream() instead.*/
inline Font* readFont3DStream(std::istream& stream, const osgDB::ReaderWriter::Options* userOptions = 0)
{
return readFontStream(stream, userOptions);
}
Introduced CMake option OSG_PROVIDE_READFILE option that defaults to ON, but when switched to OFF disables the building of the osgDB::read*File() methods, forcing users to use osgDB::readRef*File() methods. The later is preferable as it closes a potential threading bug when using paging databases in conjunction with the osgDB::Registry Object Cache. This threading bug occurs when one thread gets an object from the Cache via an osgDB::read*File() call where only a pointer to the object is passed back, so taking a reference to the object is delayed till it gets reassigned to a ref_ptr<>, but at the same time another thread calls a flush of the Object Cache deleting this object as it's referenceCount is now zero. Using osgDB::readREf*File() makes sure the a ref_ptr<> is passed back and the referenceCount never goes to zero. To ensure the OSG builds when OSG_PROVIDE_READFILE is to OFF the many cases of osgDB::read*File() usage had to be replaced with a ref_ptr<> osgDB::readRef*File() usage. The avoid this change causing lots of other client code to be rewritten to handle the use of ref_ptr<> in place of C pointer I introduced a serious of templte methods in various class to adapt ref_ptr<> to the underly C pointer to be passed to old OSG API's, example of this is found in include/osg/Group: bool addChild(Node* child); // old method which can only be used with a Node* tempalte<class T> bool addChild(const osg::ref_ptr<T>& child) { return addChild(child.get()); } // adapter template method These changes together cover 149 modified files, so it's a large submission. This extent of changes are warrent to make use of the Object Cache and multi-threaded loaded more robust. git-svn-id: http://svn.openscenegraph.org/osg/OpenSceneGraph/branches/OpenSceneGraph-3.4@15165 16af8721-9629-0410-8352-f15c8da7e697
2015-10-22 22:14:53 +08:00
#endif
2010-09-22 17:50:07 +08:00
/** deprecated, use readRefFontFile() instead.*/
inline osg::ref_ptr<Font> readRefFont3DFile(const std::string& filename, const osgDB::ReaderWriter::Options* userOptions = 0)
{
return readRefFontFile(filename, userOptions);
}
2010-09-22 17:50:07 +08:00
/** deprecated, use readRefFontStream() instead.*/
inline osg::ref_ptr<Font> readRefFont3DStream(std::istream& stream, const osgDB::ReaderWriter::Options* userOptions = 0)
{
return readRefFontStream(stream, userOptions);
}
2010-09-22 17:50:07 +08:00
/** deprecated, use findFontFile() instead.*/
inline std::string findFont3DFile(const std::string& str)
{
return findFontFile(str);
}
}
#endif