Commons.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------------
//
// Pro-Vocation Light Engine (PVLE)
// Copyright (C) 2007-2009  Sukender, KinoX & Buzib
// For more information, contact us : sukender@free.fr
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// For any use that is not compatible with the terms of the GNU 
// General Public License, please contact the authors for alternative
// licensing options.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
//-----------------------------------------------------------------------------------


#ifndef _3D_COMMONS_H
#define _3D_COMMONS_H

#include <PVLE/Export.h>

#include <utility>
#include <osg/Vec3>
#include <osg/Vec4>
#include <osg/Matrix>

#include <boost/filesystem/path.hpp>

namespace osg {
    class Node;
    class Group;
    class Geode;
    class Geometry;
    class Transform;
    class Projection;
    class Drawable;
    class Stateset;
    class MatrixTransform;
    class Material;
    class Image;
    class HeightField;
}

namespace osgText {
    class Text;
    class Font;
}

PVLE_EXPORT osg::Transform * createSkySphere(const boost::filesystem::path & texturePath, float detailRatio = 0.5f);

class PVLE_EXPORT CloudParams {
public:
    CloudParams();

    unsigned int numSprites;                
    boost::filesystem::path imagePath;      

    float ratio;            
    float density;          
    float spriteSizeMin;    
    float spriteSizeMax;    
    //enum EMode { SPRITE, BILLBOARD_AXIS, BILLBOARD_EYE, POINT_SPRITE };
    //EMode mode;
    const osg::Vec3 axis;   
    osg::Vec4f lowColor;    
    osg::Vec4f hiColor;     
    float alphaOffsetMin;   
    float alphaOffsetMax;   
    float skewVMin;         
    float skewVMax;         
    float skewHMin;         
    float skewHMax;         
    float colorScaleRand;   
};

PVLE_EXPORT osg::Geode * createCloud(const CloudParams & params);
PVLE_EXPORT osg::Geode * createCloud(const boost::filesystem::path & imagePath, unsigned int numSprites = 100);

PVLE_EXPORT osg::Geometry * createAxisDrawable(const osg::Vec3& corner, const osg::Vec3& xdir, const osg::Vec3& ydir, const osg::Vec3& zdir);

PVLE_EXPORT osg::Geometry * createSegmentDrawable(const osg::Vec3 & p1, const osg::Vec3 & p2, float width = 3, const osg::Vec4 & color1 = osg::Vec4(1,1,1,1), const osg::Vec4 & color2 = osg::Vec4(-1,-1,-1,-1));

PVLE_EXPORT osg::Geode * createAxis(float axisSize);

PVLE_EXPORT osg::Geode * createSegment(const osg::Vec3 & p1, const osg::Vec3 & p2, float width = 3, const osg::Vec4 & color1 = osg::Vec4(1,1,1,1), const osg::Vec4 & color2 = osg::Vec4(-1,-1,-1,-1));

PVLE_EXPORT osgText::Text * createText(osgText::Font * pFont, float height = 20.f, const osg::Vec3f & position = osg::Vec3f(0,0,0), const osg::Vec4f & color = osg::Vec4f(.5f, .5f, .5f, 1));

PVLE_EXPORT osg::Geometry * createSquare(const osg::Vec3& corner, const osg::Vec3& width, const osg::Vec3& height, osg::Image* image = NULL, unsigned int nbTextureCoords = 1, bool invertYTexCoords = false);

inline osg::Geometry * createSquareFor2D(const osg::Vec3& corner2D, const osg::Vec3& boxSize2D, osg::Image* image = NULL, unsigned int nbTextureCoords = 1, bool invertYTexCoords = false) {
    return createSquare(corner2D, osg::Vec3(boxSize2D.x(),0,0), osg::Vec3(0,-boxSize2D.y(),0), image, nbTextureCoords, !invertYTexCoords);
}

inline osg::Geometry * createSquareFor2D(const osg::Vec3& corner2D, float boxSize2DX, float boxSize2DY, osg::Image* image = NULL, unsigned int nbTextureCoords = 1, bool invertYTexCoords = false) {
    return createSquareFor2D(corner2D, osg::Vec3(boxSize2DX,boxSize2DY,0), image, nbTextureCoords, invertYTexCoords);
}

PVLE_EXPORT void updateSquare(osg::Geometry * pGeometry, const osg::Vec3& width, const osg::Vec3& height);

PVLE_EXPORT void updateSquare(osg::Geometry * pGeometry, const osg::Vec3& corner, const osg::Vec3& width, const osg::Vec3& height);

inline void updateSquareFor2D(osg::Geometry * pGeometry, float width, float height) {
    updateSquare(pGeometry, osg::Vec3(width,0,0), osg::Vec3(0,-height,0));
}

inline void updateSquareFor2D(osg::Geometry * pGeometry, const osg::Vec3& corner, float width, float height) {
    updateSquare(pGeometry, corner, osg::Vec3(width,0,0), osg::Vec3(0,-height,0));
}

PVLE_EXPORT std::pair<osg::Projection*, osg::MatrixTransform*> create2DProjection(const osg::Matrix & orthoProjectionMatrix);

PVLE_EXPORT osg::Projection * encapsulateIn2DProjection(osg::Node * pNode, const osg::Matrix & orthoProjectionMatrix);

PVLE_EXPORT void setHudStatset(osg::StateSet * pStateset);

PVLE_EXPORT void setColor(osg::StateSet * pStateSet, const osg::Vec4 & color);
PVLE_EXPORT void setColor(osg::Node * pNode, const osg::Vec4 & color);

PVLE_EXPORT osg::MatrixTransform * createShapeGeode(osg::Shape * shape, float tesselationDetailRatio = 0);
PVLE_EXPORT osg::MatrixTransform * createShapeGeodeBox(const osg::Vec3 & size);     // Removed "float tesselationDetailRatio = 0" since it has no effect on a box
PVLE_EXPORT osg::MatrixTransform * createShapeGeodeSphere(const float radius, float tesselationDetailRatio = 0);
PVLE_EXPORT osg::MatrixTransform * createShapeGeodeCapsule(const float radius, const float length, float tesselationDetailRatio = 0);
PVLE_EXPORT osg::MatrixTransform * createShapeGeodeCylinder(const float radius, const float length, float tesselationDetailRatio = 0);

PVLE_EXPORT osg::HeightField * readHeightMap(const boost::filesystem::path & path, const float vScale = 1.f, const float hScale = 3000.f);


#endif  // _3D_COMMONS_H

---