///////////////////////////////////////////////////////////////////////////////
|
// Copyright (C) 2002-2016, Open Design Alliance (the "Alliance").
|
// All rights reserved.
|
//
|
// This software and its documentation and related materials are owned by
|
// the Alliance. The software may only be incorporated into application
|
// programs owned by members of the Alliance, subject to a signed
|
// Membership Agreement and Supplemental Software License Agreement with the
|
// Alliance. The structure and organization of this software are the valuable
|
// trade secrets of the Alliance and its suppliers. The software is also
|
// protected by copyright law and international treaty provisions. Application
|
// programs incorporating this software must include the following statement
|
// with their copyright notices:
|
//
|
// This application incorporates Teigha(R) software pursuant to a license
|
// agreement with Open Design Alliance.
|
// Teigha(R) Copyright (C) 2002-2016 by Open Design Alliance.
|
// All rights reserved.
|
//
|
// By use of this software, its documentation or related materials, you
|
// acknowledge and accept the above terms.
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
#ifndef _OD_DB_3D_POLYLINE_
|
#define _OD_DB_3D_POLYLINE_
|
|
#include "TD_PackPush.h"
|
|
#include "DbCurve.h"
|
#include "DbObjectIterator.h"
|
|
class OdDb3dPolylineVertex;
|
class OdDbSequenceEnd;
|
|
/** \details
|
This template class is a specialization of the OdSmartPtr class for OdDb3dPolylineVertex object pointers.
|
*/
|
typedef OdSmartPtr<OdDb3dPolylineVertex> OdDb3dPolylineVertexPtr;
|
/** \details
|
This template class is a specialization of the OdSmartPtr class for OdDbSequenceEnd object pointers.
|
*/
|
typedef OdSmartPtr<OdDbSequenceEnd> OdDbSequenceEndPtr;
|
|
/** \details
|
|
<group TD_Namespaces>
|
*/
|
namespace OdDb
|
{
|
enum Poly3dType
|
{
|
k3dSimplePoly = 0, // Simple polyline.
|
k3dQuadSplinePoly = 1, // Quadratic B-spline fit (DXF 80, bit 0x08; DXF 75 == 5).
|
k3dCubicSplinePoly = 2 // Cubic B-spline-fit (DXF 80, bit 0x08; DXF 75 == 6).
|
};
|
}
|
|
/** \details
|
This class represents 3D Polyline entities in an OdDbDatabase instance.
|
|
\sa
|
TD_Db
|
<group OdDb_Classes>
|
*/
|
class TOOLKIT_EXPORT OdDb3dPolyline: public OdDbCurve
|
{
|
public:
|
|
ODDB_DECLARE_MEMBERS(OdDb3dPolyline);
|
|
OdDb3dPolyline();
|
|
/** \details
|
Sets this Polyline entity closed (DXF 70, bit 0x01=1).
|
*/
|
void makeClosed();
|
|
/** \details
|
Sets this Polyline entity open (DXF 70, bit 0x01=0).
|
*/
|
void makeOpen();
|
|
/** \details
|
Returns the type of this Polyline entity.
|
|
\remarks
|
polyType() returns one of the following:
|
|
<table>
|
Name Value Description
|
OdDb::k3dSimplePoly 0 Simple polyline.
|
OdDb::k3dQuadSplinePoly 1 Quadratic B-spline fit (DXF 80, bit 0x08; DXF 75 == 5).
|
OdDb::k3dCubicSplinePoly 2 Cubic B-spline-fit (DXF 80, bit 0x08; DXF 75 == 6).
|
</table>
|
*/
|
OdDb::Poly3dType polyType() const;
|
|
/** \details
|
Sets the type of this Polyline entity.
|
|
\param polyType [in] Polyline type.
|
|
\remarks
|
polyType() returns one of the following:
|
|
<table>
|
Name Value Description
|
OdDb::k3dSimplePoly 0 Simple polyline.
|
OdDb::k3dQuadSplinePoly 1 Quadratic B-spline fit (DXF 80, bit 0x08; DXF 75 == 5).
|
OdDb::k3dCubicSplinePoly 2 Cubic B-spline-fit (DXF 80, bit 0x08; DXF 75 == 6).
|
</table>
|
*/
|
void setPolyType(
|
OdDb::Poly3dType polyType);
|
|
/** \details
|
Removes all spline fitting from this Polyline entity.
|
|
\remarks
|
Removes all but the simple vertices.
|
*/
|
void straighten();
|
|
/** \details
|
Appends the specified Vertex entity to this Polyline entity, and makes this Polyline entity its owner.
|
|
\remarks
|
Returns the Object ID of the appended vertex.
|
|
If this Polyline entity is database resident, the Vertex entity will be made database resident.
|
|
If this Polyline entity is not database resident, the Vertex entity will be made database resident
|
when this Polyline entity is made database resident.
|
|
\note
|
If this Polyline is database resident, the Vertex entity must explicitly be closed when
|
appendVertex() returns.
|
|
\param pVertex [in] Pointer to the Vertex entity to be appended.
|
*/
|
OdDbObjectId appendVertex(
|
OdDb3dPolylineVertex* pVertex);
|
|
/** \details
|
Inserts the specified Vertex entity into this Polyline entity
|
after the specified vertex, and makes this Polyline its owner.
|
|
\remarks
|
Returns the Object ID of the newly inserted vertex.
|
|
The Vertex will be made database resident.
|
|
If this Polyline entity is not database resident, the vertex will be made database resident
|
when the polyline is made database resident.
|
|
To insert the specified Vertex at the start of this Polyline, use a null indexVertexId.
|
|
\note
|
The Vertex entity must explicitly be closed when insertertex() returns.
|
|
\param indexVertId [in] Object ID of vertex after which to insert the specified vertex.
|
\param pVertex [in] Pointer to the Vertex entity to be inserted.
|
|
*/
|
OdDbObjectId insertVertexAt(
|
const OdDbObjectId& indexVertId,
|
OdDb3dPolylineVertex* pVertex);
|
|
/** \param pIndexVert [in] Pointer to vertex after which to insert the specified vertex.
|
*/
|
OdDbObjectId insertVertexAt(
|
const OdDb3dPolylineVertex* pIndexVert,
|
OdDb3dPolylineVertex* pVertex);
|
|
/** \details
|
Opens a vertex owned by this Polyline entity.
|
|
\param vertId [in] Object ID of vertex to be opened.
|
\param mode [in] Mode in which to open the vertex.
|
\param openErasedOne [in] If and only if true, erased objects will be opened.
|
|
\remarks
|
Returns a SmartPointer to the opened object if successful, otherwise a null SmartPointer.
|
*/
|
OdDb3dPolylineVertexPtr openVertex(
|
OdDbObjectId vertId,
|
OdDb::OpenMode mode,
|
bool openErasedOne = false);
|
|
/** \details
|
Opens the OdDbSequenceEnd entity for this Polyline entity.
|
|
\param mode [in] Mode in which to open the OdDbSequenceEnd entity.
|
|
\remarks
|
Returns a SmartPointer to the newly opened OdDbSequenceEnd, or a null SmartPointer.
|
|
\note
|
This method is provided solely for applications that store XData on
|
OdDbSequenceEnd entities; this is not recommended.
|
*/
|
OdDbSequenceEndPtr openSequenceEnd(
|
OdDb::OpenMode mode);
|
|
/** \details
|
Returns a SmartPointer to an iterator that can be used to traverse the vertices owned
|
by this Polyline entity.
|
*/
|
OdDbObjectIteratorPtr vertexIterator() const;
|
|
virtual void dxfOut(
|
OdDbDxfFiler* pFiler) const;
|
|
virtual OdResult dxfIn(
|
OdDbDxfFiler* pFiler);
|
|
virtual OdResult dwgInFields(
|
OdDbDwgFiler* pFiler);
|
|
virtual void dwgOutFields(
|
OdDbDwgFiler* pFiler) const;
|
|
virtual OdResult dxfInFields(
|
OdDbDxfFiler* pFiler);
|
|
virtual void dxfOutFields(
|
OdDbDxfFiler* pFiler) const;
|
|
virtual OdResult dxfInFields_R12(
|
OdDbDxfFiler* pFiler);
|
|
virtual void dxfOutFields_R12(
|
OdDbDxfFiler* pFiler) const;
|
|
virtual OdResult subGetClassID(
|
void* pClsid) const;
|
|
void subClose();
|
|
virtual OdResult subExplode(
|
OdRxObjectPtrArray& entitySet) const;
|
|
virtual OdResult explodeGeometry(
|
OdRxObjectPtrArray& entitySet) const;
|
|
virtual OdResult subTransformBy(
|
const OdGeMatrix3d& xfm);
|
|
virtual bool subWorldDraw(
|
OdGiWorldDraw* pWd) const;
|
|
virtual bool isPlanar() const;
|
|
virtual OdResult getPlane(
|
OdGePlane& plane,
|
OdDb::Planarity& planarity) const;
|
|
|
/* OdDbCurveMethods */
|
|
/** \details
|
Returns true if 3D-Polyline is closed or false otherwise.
|
*/
|
virtual bool isClosed() const;
|
|
virtual bool isPeriodic() const;
|
|
virtual OdResult getStartParam(
|
double& startParam) const;
|
|
virtual OdResult getEndParam(
|
double& endParam) const;
|
|
virtual OdResult getStartPoint(
|
OdGePoint3d& startPoint) const;
|
|
virtual OdResult getEndPoint(
|
OdGePoint3d& endPoint) const;
|
|
virtual OdResult getPointAtParam(
|
double param,
|
OdGePoint3d& pointOnCurve) const;
|
|
virtual OdResult getParamAtPoint(
|
const OdGePoint3d& pointOnCurve,
|
double& param) const;
|
|
virtual OdResult getDistAtParam( double param, double& dist ) const;
|
|
virtual OdResult getParamAtDist( double dist, double& param ) const;
|
|
virtual OdResult getFirstDeriv (
|
double param,
|
OdGeVector3d& firstDeriv) const;
|
|
virtual OdResult getSecondDeriv (
|
double param,
|
OdGeVector3d& secondDeriv) const;
|
|
virtual OdResult getArea(
|
double& area) const;
|
|
TD_USING(OdDbCurve::getFirstDeriv);
|
TD_USING(OdDbCurve::getSecondDeriv);
|
|
|
/** \details
|
Convert 3D-Polyline to the specified type.
|
|
\param newVal [in] Polyline type.
|
|
\remarks
|
newVal must be one of the following:
|
|
<table>
|
Name Value Description
|
OdDb::k3dSimplePoly 0 Simple polyline.
|
OdDb::k3dQuadSplinePoly 1 Quadratic B-spline fit (DXF 80, bit 0x08; DXF 75 == 5).
|
OdDb::k3dCubicSplinePoly 2 Cubic B-spline-fit (DXF 80, bit 0x08; DXF 75 == 6).
|
</table>
|
*/
|
OdResult convertToPolyType(OdDb::Poly3dType newVal);
|
|
/** \details
|
Transforms all simple vertices to control vertices and creates a new spline-fit vertices based
|
on a control vertices, through which the polyline will be drawn.
|
|
\returns eOk if successful, or an appropriate error code if not.
|
*/
|
OdResult splineFit();
|
|
/** \details
|
Transforms all simple vertices to control vertices and creates a new spline-fit vertices based
|
on a control vertices, through which the polyline will be drawn.
|
|
\param splineType [in] Spline-Fit Polyline type.
|
|
\param splineSegs [in] Number of Spline-Fit segments.
|
|
\returns eOk if successful, or an appropriate error code if not.
|
*/
|
OdResult splineFit(OdDb::Poly3dType splineType, OdInt16 splineSegs);
|
OdResult subGetSubentPathsAtGsMarker( OdDb::SubentType type,
|
OdGsMarker gsMark,
|
const OdGePoint3d& ,
|
const OdGeMatrix3d& ,
|
OdDbFullSubentPathArray& subentPaths,
|
const OdDbObjectIdArray* pEntAndInsertStack ) const;
|
OdResult subGetGsMarkersAtSubentPath( const OdDbFullSubentPath& subPath,
|
OdGsMarkerArray& gsMarkers) const;
|
|
OdDbEntityPtr subSubentPtr(const OdDbFullSubentPath& path) const;
|
|
virtual OdResult getOdGeCurve(OdGeCurve3d*& pGeCurve, const OdGeTol& tol = OdGeContext::gTol) const;
|
virtual OdResult setFromOdGeCurve(const OdGeCurve3d& geCurve, OdGeVector3d *normal = NULL, const OdGeTol& tol = OdGeContext::gTol);
|
|
/** \details
|
Reverses the Polyline so that the first vertex become the last vertex of a Polyline
|
and the last vertex become the first vertex.
|
|
\returns eOk if successful, or an appropriate error code if not.
|
*/
|
virtual OdResult reverseCurve();
|
};
|
|
/** \details
|
This template class is a specialization of the OdSmartPtr class for OdDb3dPolyline object pointers.
|
*/
|
typedef OdSmartPtr<OdDb3dPolyline> OdDb3dPolylinePtr;
|
|
#include "TD_PackPop.h"
|
|
#endif
|
