///////////////////////////////////////////////////////////////////////////////
|
// 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 _ODGSCULLINGVOLUME_H_INCLUDED_
|
#define _ODGSCULLINGVOLUME_H_INCLUDED_
|
|
#include "OdaCommon.h"
|
#include "RxObject.h"
|
#include "Gs/GsExport.h"
|
#include "Ge/GeBoundBlock3d.h"
|
#include "Ge/GeExtents3d.h"
|
#include "Ge/GePoint3d.h"
|
#include "Ge/GeSphere.h"
|
#include "Ge/GeVector3d.h"
|
|
#include "TD_PackPush.h"
|
|
// Culling primitives:
|
// BBox (AABB - Axis Aligned Bounding Box)
|
// BSphere (Bounding Sphere)
|
// OBBox (OBB - Oriented Bounding Box)
|
|
/** \details
|
Base class for culling primitives.
|
|
Library: TD_Gs
|
|
<group OdGs_Classes>
|
*/
|
class GS_TOOLKIT_EXPORT OdGsCullingPrimitive
|
{
|
public:
|
/** \details
|
Type of culling primitive.
|
|
\remarks
|
<table>
|
Name Value Description
|
kPrimBBox 0 Axis Alligned Bounding Box.
|
kPrimBSphere 1 Bounding Sphere.
|
kPrimOBBox 2 Oriented Bounding Box.
|
</table>
|
*/
|
enum PrimitiveType
|
{
|
kPrimBBox,
|
kPrimBSphere,
|
kPrimOBBox
|
};
|
public:
|
OdGsCullingPrimitive()
|
{
|
}
|
|
virtual ~OdGsCullingPrimitive()
|
{
|
}
|
|
/** \details
|
Returns culling primitive type.
|
|
\remarks
|
<table>
|
Name Value Description
|
kPrimBBox 0 Axis Alligned Bounding Box.
|
kPrimBSphere 1 Bounding Sphere.
|
kPrimOBBox 2 Oriented Bounding Box.
|
</table>
|
*/
|
virtual PrimitiveType primitiveType() const = 0;
|
};
|
|
/** \details
|
Culling primitive: axis alligned bounding box.
|
|
Library: TD_Gs
|
|
<group OdGs_Classes>
|
*/
|
class GS_TOOLKIT_EXPORT OdGsCullingBBox : public OdGsCullingPrimitive, public OdGeExtents3d
|
{
|
public:
|
OdGsCullingBBox()
|
: OdGsCullingPrimitive()
|
, OdGeExtents3d()
|
{
|
}
|
|
OdGsCullingBBox(const OdGePoint3d &min, const OdGePoint3d &max)
|
: OdGsCullingPrimitive()
|
, OdGeExtents3d(min, max)
|
{
|
}
|
|
OdGsCullingBBox(const OdGeExtents3d &ext)
|
: OdGsCullingPrimitive()
|
, OdGeExtents3d(ext.minPoint(), ext.maxPoint())
|
{
|
}
|
|
OdGsCullingBBox(const OdGsCullingBBox &aabb)
|
: OdGsCullingPrimitive()
|
, OdGeExtents3d(aabb.minPoint(), aabb.maxPoint())
|
{
|
}
|
|
~OdGsCullingBBox()
|
{
|
}
|
|
OdGsCullingBBox &operator =(const OdGeExtents3d &ext)
|
{
|
set(ext.minPoint(), ext.maxPoint());
|
return *this;
|
}
|
|
OdGsCullingBBox &operator =(const OdGsCullingBBox &aabb)
|
{
|
set(aabb.minPoint(), aabb.maxPoint());
|
return *this;
|
}
|
|
// OdGsCullingPrimitive overrides
|
|
/** \details
|
Returns culling primitive type.
|
*/
|
PrimitiveType primitiveType() const
|
{
|
return kPrimBBox;
|
}
|
};
|
|
/** \details
|
Culling primitive: bounding sphere.
|
|
Library: TD_Gs
|
|
<group OdGs_Classes>
|
*/
|
class GS_TOOLKIT_EXPORT OdGsCullingBSphere : public OdGsCullingPrimitive, public OdGeSphere // GeSphere has many unnecessary data for culling
|
{
|
public:
|
OdGsCullingBSphere()
|
: OdGsCullingPrimitive()
|
, OdGeSphere()
|
{
|
}
|
|
OdGsCullingBSphere(double radius, const OdGePoint3d ¢er)
|
: OdGsCullingPrimitive()
|
, OdGeSphere(radius, center)
|
{
|
}
|
|
OdGsCullingBSphere(const OdGeSphere &sphere)
|
: OdGsCullingPrimitive()
|
, OdGeSphere(sphere)
|
{
|
}
|
|
OdGsCullingBSphere(const OdGsCullingBSphere &bsphere)
|
: OdGsCullingPrimitive()
|
, OdGeSphere(bsphere)
|
{
|
}
|
|
~OdGsCullingBSphere()
|
{
|
}
|
|
OdGsCullingBSphere &operator =(const OdGeSphere &sphere)
|
{
|
set(sphere.radius(), sphere.center());
|
return *this;
|
}
|
|
OdGsCullingBSphere &operator =(const OdGsCullingBSphere &bsphere)
|
{
|
set(bsphere.radius(), bsphere.center());
|
return *this;
|
}
|
|
// OdGsCullingPrimitive overrides
|
|
/** \details
|
Returns culling volume type.
|
*/
|
PrimitiveType primitiveType() const
|
{
|
return kPrimBSphere;
|
}
|
};
|
|
/** \details
|
Culling primitive: oriented bounding box.
|
|
Library: TD_Gs
|
|
<group OdGs_Classes>
|
*/
|
class GS_TOOLKIT_EXPORT OdGsCullingOBBox : public OdGsCullingPrimitive, public OdGeBoundBlock3d
|
{
|
public:
|
OdGsCullingOBBox()
|
: OdGsCullingPrimitive()
|
, OdGeBoundBlock3d()
|
{
|
}
|
|
OdGsCullingOBBox(const OdGePoint3d &base, const OdGeVector3d &xAxis, const OdGeVector3d &yAxis, const OdGeVector3d &zAxis)
|
: OdGsCullingPrimitive()
|
, OdGeBoundBlock3d(base, xAxis, yAxis, zAxis)
|
{
|
}
|
|
OdGsCullingOBBox(const OdGeBoundBlock3d &bb)
|
: OdGsCullingPrimitive()
|
, OdGeBoundBlock3d(bb)
|
{
|
}
|
|
OdGsCullingOBBox(const OdGsCullingOBBox &obb)
|
: OdGsCullingPrimitive()
|
, OdGeBoundBlock3d(obb)
|
{
|
}
|
|
~OdGsCullingOBBox()
|
{
|
}
|
|
OdGsCullingOBBox &operator =(const OdGeBoundBlock3d &bb)
|
{
|
OdGePoint3d base; OdGeVector3d side1, side2, side3;
|
bb.get(base, side1, side2, side3);
|
set(base, side1, side2, side3);
|
return *this;
|
}
|
|
OdGsCullingOBBox &operator =(const OdGsCullingOBBox &obb)
|
{
|
OdGePoint3d base; OdGeVector3d side1, side2, side3;
|
obb.get(base, side1, side2, side3);
|
set(base, side1, side2, side3);
|
return *this;
|
}
|
|
// OdGsCullingPrimitive overrides
|
|
/** \details
|
Returns culling primitive type.
|
*/
|
PrimitiveType primitiveType() const
|
{
|
return kPrimOBBox;
|
}
|
};
|
|
// Projection culling primitives:
|
// Ortho (Orthogonal culling box merged with optimization for 2d mode)
|
// Frustum (Perspective culling box without near and far culling planes)
|
|
/** \details
|
Base class for orthogonal and perspective culling volumes.
|
|
Library: TD_Gs
|
|
<group OdGs_Classes>
|
*/
|
class GS_TOOLKIT_EXPORT OdGsCullingVolume : public OdRxObject
|
{
|
public:
|
enum ProjectionType
|
{
|
kProjOrtho,
|
kProjPerspective
|
};
|
enum IntersectionStatus
|
{
|
kIntersectNot, // No intersection detected
|
kIntersectOk, // Intersects with projection boundary
|
kIntersectIn // Primitive completely inside projection boundary
|
};
|
public:
|
ODRX_DECLARE_MEMBERS(OdGsCullingVolume);
|
|
/** \details
|
Returns type of projection for this culling volume object.
|
|
\remarks
|
<table>
|
Name Value Description
|
kProjOrtho 0 Orthogonal projection.
|
kProjPerspective 1 Perspective projection.
|
</table>
|
*/
|
virtual ProjectionType projectionType() const = 0;
|
|
/** \details
|
Optimized intersection test between culling volume and culling primitive.
|
\param prim [in] Input primitive for culling detection.
|
*/
|
virtual bool intersectWithOpt(const OdGsCullingPrimitive &prim) const = 0;
|
/** \details
|
Intersection test between culling volume and culling primitive (returns complete and incomplete
|
intersection statuses).
|
|
\remarks
|
Return value intersection statuses:
|
<table>
|
Name Value Description
|
kIntersectNot 0 No intersection detected.
|
kIntersectOk 1 Intersects with culling volume boundary.
|
kIntersectIn 2 Culling volume primitive is completely inside culling volume boundary.
|
</table>
|
|
\param prim [in] Input primitive for culling detection.
|
*/
|
virtual IntersectionStatus intersectWith(const OdGsCullingPrimitive &prim) const = 0;
|
|
/** \details
|
Transform culling volume by transformation matrix.
|
\param xfm [in] Xform matrix.
|
*/
|
virtual void transformBy(const OdGeMatrix3d& xfm) = 0;
|
};
|
|
/** \details
|
This template class is a specialization of the OdSmartPtr class for OdGsCullingVolume object pointers.
|
*/
|
typedef OdSmartPtr<OdGsCullingVolume> OdGsCullingVolumePtr;
|
|
/** \details
|
Orthogonal culling volume.
|
|
Library: TD_Gs
|
|
<group OdGs_Classes>
|
*/
|
class GS_TOOLKIT_EXPORT OdGsOrthoCullingVolume : public OdGsCullingVolume
|
{
|
public:
|
ODRX_DECLARE_MEMBERS(OdGsOrthoCullingVolume);
|
|
/** \details
|
Initialize frustum culling volume by new values.
|
\param position [in] View position.
|
\param direction [in] View direction.
|
\param upVector [in] View up vector.
|
\param volumeWidth [in] Horizontal field of view.
|
\param volumeHeight [in] Vertical field of view.
|
*/
|
virtual void init(const OdGePoint3d &position, const OdGeVector3d &direction, const OdGeVector3d &upVector,
|
double volumeWidth, double volumeHeight) = 0;
|
};
|
|
/** \details
|
This template class is a specialization of the OdSmartPtr class for OdGsOrthoCullingVolume object pointers.
|
*/
|
typedef OdSmartPtr<OdGsOrthoCullingVolume> OdGsOrthoCullingVolumePtr;
|
|
/** \details
|
Perspective culling volume.
|
|
Library: TD_Gs
|
|
<group OdGs_Classes>
|
*/
|
class GS_TOOLKIT_EXPORT OdGsFrustumCullingVolume : public OdGsCullingVolume
|
{
|
public:
|
ODRX_DECLARE_MEMBERS(OdGsFrustumCullingVolume);
|
|
/** \details
|
Initialize frustum culling volume by new values.
|
\param position [in] View position.
|
\param direction [in] View direction.
|
\param upVector [in] View up vector.
|
\param fovY [in] Horizontal field of view in radians.
|
\param aspect [in] Aspect ratio between horizontal and vertical field of view (aspect = h / v).
|
\param nPlanes [in] Number of culling planes to test intersection (1,2,3,4 - enable only side planes, 5 - enable nearZ plane, 6 - enable farZ plane).
|
\param nearZ [in] Near Z-axis culling plane (must be greater than zero).
|
\param farZ [in] Far Z-axis culling plane.
|
*/
|
virtual void init(const OdGePoint3d &position, const OdGeVector3d &direction, const OdGeVector3d &upVector,
|
double fovY, double aspect, OdUInt32 nPlanes = 4, double nearZ = 1.0, double farZ = 1e20) = 0;
|
/** \details
|
Initialize frustum culling volume by new values.
|
\param position [in] View position.
|
\param direction [in] View direction.
|
\param upVector [in] View up vector.
|
\param fovX [in] Horizontal field of view in radians.
|
\param aspect [in] If enabled - then fovY is aspect ratio (fovY = h / v), elsewhere fovY is vertical field of view in radians.
|
\param fovY [in] Aspect ratio or vertical field of view in radians (see aspect argument description).
|
\param nPlanes [in] Number of culling planes to test intersection (1,2,3,4 - enable only side planes, 5 - enable nearZ plane, 6 - enable farZ plane).
|
\param nearZ [in] Near Z-axis culling plane (must be greater than zero).
|
\param farZ [in] Far Z-axis culling plane.
|
*/
|
virtual void init(const OdGePoint3d &position, const OdGeVector3d &direction, const OdGeVector3d &upVector,
|
double fovX, bool aspect, double fovY, OdUInt32 nPlanes = 4, double nearZ = 1.0, double farZ = 1e20) = 0;
|
};
|
|
/** \details
|
This template class is a specialization of the OdSmartPtr class for OdGsFrustumCullingVolume object pointers.
|
*/
|
typedef OdSmartPtr<OdGsFrustumCullingVolume> OdGsFrustumCullingVolumePtr;
|
|
#include "TD_PackPop.h"
|
|
#endif // _ODGSCULLINGVOLUME_H_INCLUDED_
|
