///////////////////////////////////////////////////////////////////////////////
|
// 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_GEEXTC3D_H
|
#define OD_GEEXTC3D_H /*!DOM*/
|
|
class OdGeLine3d;
|
class OdGeLineSeg3d;
|
class OdGeRay3d;
|
class OdGeEllipArc3d;
|
class OdGeNurbCurve3d;
|
|
#include "Ge/GeCurve3d.h"
|
|
#include "TD_PackPush.h"
|
|
/** \details
|
This class represents, as OdGeCurve3d curves, 3D curves whose definitions are external to the OdGe library.
|
|
\remarks
|
OdGeExternalCurve3d curve instances can be treated as any other OdCurve3d.
|
|
You can access the OdGeExternalCurve3d as a corresponding native OdGeCurve3d curve, if such a corresponding
|
curve exists, or you may (more efficiently) access the external data in its native form.
|
|
One example of using OdGeOdGeExternalCurve3d is to represent an ACIS curve.
|
|
Library: TD_Ge
|
|
<group OdGe_Classes>
|
*/
|
class GE_TOOLKIT_EXPORT OdGeExternalCurve3d : public OdGeCurve3d
|
{
|
public:
|
|
|
/** \param pCurveDef [in] Pointer to the curve definition.
|
\param curveKind [in] Information about system that created the curve.
|
\param makeCopy [in] Makes a copy of the curve definition.
|
\param source [in] Object to be cloned.
|
|
\remarks
|
Without arguments, the constructor creates an empty instance.
|
|
Possible values for curveKind:
|
|
@untitled table
|
kAcisEntity
|
kExternalEntityUndefined
|
*/
|
OdGeExternalCurve3d();
|
OdGeExternalCurve3d(
|
const OdGeExternalCurve3d& source);
|
OdGeExternalCurve3d(
|
void* pCurveDef,
|
OdGe::ExternalEntityKind curveKind,
|
bool makeCopy = true);
|
|
/** \details
|
Return true if and only if the external curve can be represented as an OdGeLine3d.
|
*/
|
bool isLine() const;
|
|
/** \details
|
Return true if and only if the external curve can be represented as an OdGeRay3d.
|
*/
|
bool isRay() const;
|
|
/** \details
|
Return true if and only if the external curve can be represented as an OdGeLineSeg3d.
|
*/
|
bool isLineSeg() const;
|
|
/** \details
|
Return true if and only if the external curve can be represented as an OdGeCircArc3d.
|
*/
|
bool isCircArc() const;
|
|
/** \details
|
Return true if and only if the external curve can be represented as an OdGeEllipArc3d.
|
*/
|
bool isEllipArc() const;
|
|
/** \details
|
Return true if and only if the external curve can be represented as an OdGeNurbCurve3d.
|
*/
|
bool isNurbCurve() const;
|
|
/** \details
|
Returns true if and only if the curve is defined (not an empty instance).
|
*/
|
bool isDefined() const;
|
|
/** \details
|
Return true if and only if the external curve can be represented as a native OdGeCurve3d,
|
and returns a pointer to an instance of that native curve.
|
|
\param nativeCurve [out] Receives the native curve.
|
|
\remarks
|
The returned object is created with the new operator, and it is the responsibility of the caller to delete it.
|
*/
|
bool isNativeCurve(
|
OdGeCurve3d*& nativeCurve) const;
|
|
/** \details
|
Returns a copy of the raw curve definition.
|
|
\param pCurveDef [out] Receives a pointer to a copy of the raw curve definition.
|
|
\remarks
|
It is up to the caller to delete the memory allocated.
|
*/
|
void getExternalCurve(
|
void*& pCurveDef) const;
|
|
/** \details
|
Rerurns information about the system that created the curve.
|
|
\remarks
|
Possible values for curveKind:
|
|
@untitled table
|
kAcisEntity
|
kExternalEntityUndefined
|
*/
|
OdGe::ExternalEntityKind externalCurveKind() const;
|
|
/** \details
|
Sets the parameters for this external curve according to the arguments,
|
and returns a reference to this external curve.
|
|
\param pCurveDef [in] Pointer to the curve definition.
|
\param curveKind [in] Information about system that created the curve.
|
\param makeCopy [in] If true, makes a copy of the curve definition.
|
*/
|
OdGeExternalCurve3d& set(
|
void* pCurveDef,
|
OdGe::ExternalEntityKind curveKind,
|
bool makeCopy = true);
|
|
OdGeExternalCurve3d& operator =(
|
const OdGeExternalCurve3d& extCurve);
|
|
/** \details
|
Returns true if and only if the external curve owns the data.
|
|
\remarks
|
If the external curve owns the data, it will be destroyed when
|
the curve is destroyed.
|
*/
|
bool isOwnerOfCurve() const;
|
|
/** \details
|
Forces this external curve to own the data, and returns a reference to this curve.
|
|
\remarks
|
If the external curve owns the data, it will be destroyed when
|
the curve is destroyed.
|
*/
|
OdGeExternalCurve3d& setToOwnCurve();
|
|
};
|
|
#include "TD_PackPop.h"
|
|
#endif // OD_GEEXTC3D_H
|
|
