120ca87015
git-svn-id: https://free-cad.svn.sourceforge.net/svnroot/free-cad/trunk@5000 e8eeb9e2-ec13-0410-a4a9-efa5cf37419d
236 lines
9.3 KiB
C++
236 lines
9.3 KiB
C++
/***************************************************************************
|
|
* Copyright (c) Jürgen Riegel (juergen.riegel@web.de) *
|
|
* *
|
|
* This file is part of the FreeCAD CAx development system. *
|
|
* *
|
|
* This library is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU Library General Public *
|
|
* License as published by the Free Software Foundation; either *
|
|
* version 2 of the License, or (at your option) any later version. *
|
|
* *
|
|
* This library 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 Library General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Library General Public *
|
|
* License along with this library; see the file COPYING.LIB. If not, *
|
|
* write to the Free Software Foundation, Inc., 59 Temple Place, *
|
|
* Suite 330, Boston, MA 02111-1307, USA *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
|
|
#ifndef BASE_BUILDER3D_H
|
|
#define BASE_BUILDER3D_H
|
|
|
|
// Std. configurations
|
|
|
|
#include <sstream>
|
|
#include <vector>
|
|
#include "Vector3D.h"
|
|
|
|
namespace Base
|
|
{
|
|
class Matrix4D;
|
|
/** A Builder class for 3D representations on App level
|
|
* On application level is nothing known of the visual representation of data.
|
|
* Nevertheless it's often needed to see some 3D information, e.g. points, directions,
|
|
* when you program or debug an algorithm. For that purpose Builder3D was made.
|
|
* This class allows you to build up easily a 3D representation of some math and
|
|
* algorithm internals. You can save this representation to a file and see it in an
|
|
* Inventor viewer, or put it to the log. In case of the log and a debug FreeCAD
|
|
* the representation will be loaded into the active viewer.
|
|
* \par
|
|
* The usage is the following. Create the a Builder3D object and call the methods to insert
|
|
* the graphical elements. After that call either saveToLog() or saveToFile().
|
|
* \par
|
|
* Usage:
|
|
* \code
|
|
Base::Builder3D log3D;
|
|
for ( unsigned long i=0; i<pMesh->CountPoints(); i++ )
|
|
{
|
|
log3D.addSinglePoint(pMesh->GetPoint(i));
|
|
log3D.addText(pMesh->GetPoint(i),"Point");
|
|
...
|
|
}
|
|
log3D.saveToLog();
|
|
* \endcode
|
|
* \see Base::ConsoleSingleton
|
|
*/
|
|
class BaseExport Builder3D
|
|
{
|
|
public:
|
|
/// Construction
|
|
Builder3D();
|
|
/// Destruction
|
|
virtual ~Builder3D();
|
|
|
|
/** @name point set handling */
|
|
//@{
|
|
/// starts a point set
|
|
void startPoints(short pointSize=2, float color_r=1.0,float color_g=0.0,float color_b=0.0);
|
|
/// insert a point in an point set
|
|
void addPoint(float x, float y, float z);
|
|
/// add a vector to a point set
|
|
void addPoint(const Vector3f &vec);
|
|
/// ends the points set operation
|
|
void endPoints(void);
|
|
/// add a singular point (without startPoints() & endPoints() )
|
|
void addSinglePoint(float x, float y, float z, short pointSize=2, float color_r=1.0,float color_g=1.0,float color_b=1.0);
|
|
/// add a singular point (without startPoints() & endPoints() )
|
|
void addSinglePoint(const Base::Vector3f &vec, short pointSize=2, float color_r=1.0,float color_g=1.0,float color_b=1.0);
|
|
//@}
|
|
|
|
/** @name line/direction handling */
|
|
//@{
|
|
/// add a line defined by 2 Vector3D
|
|
void addSingleLine(Vector3f pt1, Vector3f pt2, short lineSize=2, float color_r=1.0,float color_g=1.0,float color_b=1.0, unsigned short linePattern = 0xffff);
|
|
/// add a arrow (directed line) by 2 Vector3D. The arrow shows in direction of point 2.
|
|
void addSingleArrow(Vector3f pt1, Vector3f pt2, short lineSize=2, float color_r=1.0,float color_g=1.0,float color_b=1.0, unsigned short linePattern = 0xffff);
|
|
//@}
|
|
|
|
/** @name triangle handling */
|
|
//@{
|
|
/// add a (filled) triangle defined by 3 vectors
|
|
void addSingleTriangle(Vector3f pt0, Vector3f pt1, Vector3f pt2, bool filled = true, short lineSize=2, float color_r=1.0,float color_g=1.0,float color_b=1.0);
|
|
//@}
|
|
|
|
/** @name Transformation */
|
|
//@{
|
|
/// adds a transformation
|
|
void addTransformation(const Base::Matrix4D&);
|
|
void addTransformation(const Base::Vector3f& translation, const Base::Vector3f& rotationaxis, float fAngle);
|
|
//@}
|
|
|
|
/** @name text handling */
|
|
//@{
|
|
/// add a text
|
|
void addText(float pos_x, float pos_y , float pos_z,const char * text, float color_r=1.0,float color_g=1.0,float color_b=1.0);
|
|
/// add a text
|
|
void addText(const Base::Vector3f &vec,const char * text, float color_r=1.0,float color_g=1.0,float color_b=1.0);
|
|
//@}
|
|
|
|
/// clear the string buffer
|
|
void clear (void);
|
|
|
|
/** @name write the result */
|
|
//@{
|
|
/// puts the result to the log and gui
|
|
void saveToLog(void);
|
|
/// save the result to a file (*.iv)
|
|
void saveToFile(const char* FileName);
|
|
//@}
|
|
|
|
private:
|
|
/// the result string
|
|
std::stringstream result;
|
|
|
|
bool bStartEndOpen;
|
|
|
|
};
|
|
|
|
/**
|
|
* This class does basically the same as Builder3D except that it writes the data
|
|
* directly into a given stream without buffering the output data in a string stream.
|
|
* Compared to file streams string streams are quite slow when writing data with more
|
|
* than a few hundred lines. Due to performance reasons the user should use a file
|
|
* stream in this case.
|
|
* @author Werner Mayer
|
|
*/
|
|
class BaseExport InventorBuilder
|
|
{
|
|
public:
|
|
/// Construction
|
|
InventorBuilder(std::ostream&);
|
|
/// Destruction
|
|
virtual ~InventorBuilder();
|
|
void close();
|
|
|
|
void beginSeparator();
|
|
void endSeparator();
|
|
void addMaterial(float color_r,float color_g,float color_b);
|
|
void addMaterialBinding(const char* = "OVERALL");
|
|
void addDrawStyle(short pointSize, short lineWidth,
|
|
unsigned short linePattern = 0xffff, const char* style="FILLED");
|
|
|
|
/** @name Point set handling */
|
|
//@{
|
|
/// starts a point set
|
|
void beginPoints();
|
|
/// insert a point in an point set
|
|
void addPoint(float x, float y, float z);
|
|
/// add a vector to a point set
|
|
void addPoint(const Vector3f &vec);
|
|
/// ends the points set operation
|
|
void endPoints(void);
|
|
//@}
|
|
|
|
/** @name Line/Direction handling */
|
|
//@{
|
|
/// add a line defined by 2 Vector3D
|
|
void addSingleLine(const Vector3f& pt1, const Vector3f& pt2, short lineSize=2,
|
|
float color_r=1.0,float color_g=1.0,float color_b=1.0, unsigned short linePattern = 0xffff);
|
|
/// add a arrow (directed line) by 2 Vector3D. The arrow shows in direction of point 2.
|
|
void addSingleArrow(const Vector3f& pt1, const Vector3f& pt2, short lineSize=2,
|
|
float color_r=1.0,float color_g=1.0,float color_b=1.0, unsigned short linePattern = 0xffff);
|
|
/// add a line defined by a list of points whereat always a pair (i.e. a point and the following point) builds a line.
|
|
void addLineSet(const std::vector<Vector3f>& points, short lineSize=2,
|
|
float color_r=1.0,float color_g=1.0,float color_b=1.0, unsigned short linePattern = 0xffff);
|
|
void addIndexedFaceSet(const std::vector<Vector3f>& points, const std::vector<int>& indices, float crease);
|
|
//@}
|
|
|
|
/** @name Triangle handling */
|
|
//@{
|
|
/// add a (filled) triangle defined by 3 vectors
|
|
void addSingleTriangle(const Vector3f& pt0, const Vector3f& pt1, const Vector3f& pt2, bool filled = true, short lineSize=2,
|
|
float color_r=1.0,float color_g=1.0,float color_b=1.0);
|
|
void addSinglePlane(const Vector3f& base, const Vector3f& eX, const Vector3f& eY, float length, float width, bool filled = true,
|
|
short lineSize=2, float color_r=1.0,float color_g=1.0,float color_b=1.0);
|
|
//@}
|
|
|
|
/** @name Surface handling */
|
|
//@{
|
|
void addNurbsSurface(const std::vector<Base::Vector3f>& controlPoints,
|
|
int numUControlPoints, int numVControlPoints,
|
|
const std::vector<float>& uKnots, const std::vector<float>& vKnots);
|
|
void addCylinder(float radius, float height);
|
|
//@}
|
|
|
|
/** @name Bounding Box handling */
|
|
//@{
|
|
void addBoundingBox(const Vector3f& pt1, const Vector3f& pt2, short lineWidth=2,
|
|
float color_r=1.0,float color_g=1.0,float color_b=1.0);
|
|
//@}
|
|
|
|
/** @name Transformation */
|
|
//@{
|
|
/// adds a transformation
|
|
void addTransformation(const Matrix4D&);
|
|
void addTransformation(const Vector3f& translation, const Vector3f& rotationaxis, float fAngle);
|
|
//@}
|
|
|
|
/** @name Text handling */
|
|
//@{
|
|
/// add a text
|
|
void addText(float pos_x, float pos_y , float pos_z,const char * text,
|
|
float color_r=1.0,float color_g=1.0,float color_b=1.0);
|
|
/// add a text
|
|
void addText(const Vector3f &vec,const char * text, float color_r=1.0,float color_g=1.0,float color_b=1.0);
|
|
//@}
|
|
|
|
private:
|
|
InventorBuilder (const InventorBuilder&);
|
|
void operator = (const InventorBuilder&);
|
|
|
|
private:
|
|
std::ostream& result;
|
|
bool bStartEndOpen;
|
|
bool bClosed;
|
|
int indent;
|
|
};
|
|
|
|
} //namespace Base
|
|
|
|
#endif // BASE_BUILDER3D_H
|