CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
OdGsFrustumCullingVolume Class Referenceabstract

#include <GsCullingVolume.h>

Inheritance diagram for OdGsFrustumCullingVolume:
OdGsCullingVolume OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGsFrustumCullingVolume)
 
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
 
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
 
- Public Member Functions inherited from OdGsCullingVolume
 ODRX_DECLARE_MEMBERS (OdGsCullingVolume)
 
virtual ProjectionType projectionType () const =0
 
virtual bool intersectWithOpt (const OdGsCullingPrimitive &prim) const =0
 
virtual IntersectionStatus intersectWith (const OdGsCullingPrimitive &prim) const =0
 
virtual void transformBy (const OdGeMatrix3d &xfm)=0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Public Types inherited from OdGsCullingVolume
enum  ProjectionType { kProjOrtho , kProjPerspective }
 
enum  IntersectionStatus { kIntersectNot , kIntersectOk , kIntersectIn }
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

Perspective culling volume.

Corresponding C++ library: TD_Gs

<group OdGs_Classes>

Definition at line 390 of file GsCullingVolume.h.

Member Function Documentation

◆ init() [1/2]

virtual void OdGsFrustumCullingVolume::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 
)
pure virtual

Initialize frustum culling volume by new values.

Parameters
position[in] View position.
direction[in] View direction.
upVector[in] View up vector.
fovX[in] Horizontal field of view in radians.
aspect[in] If enabled - then fovY is aspect ratio (fovY = h / v), elsewhere fovY is vertical field of view in radians.
fovY[in] Aspect ratio or vertical field of view in radians (see aspect argument description).
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).
nearZ[in] Near Z-axis culling plane (must be greater than zero).
farZ[in] Far Z-axis culling plane.

◆ init() [2/2]

virtual void OdGsFrustumCullingVolume::init ( const OdGePoint3d position,
const OdGeVector3d direction,
const OdGeVector3d upVector,
double  fovY,
double  aspect,
OdUInt32  nPlanes = 4,
double  nearZ = 1.0,
double  farZ = 1e20 
)
pure virtual

Initialize frustum culling volume by new values.

Parameters
position[in] View position.
direction[in] View direction.
upVector[in] View up vector.
fovY[in] Horizontal field of view in radians.
aspect[in] Aspect ratio between horizontal and vertical field of view (aspect = h / v).
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).
nearZ[in] Near Z-axis culling plane (must be greater than zero).
farZ[in] Far Z-axis culling plane.

◆ ODRX_DECLARE_MEMBERS()

OdGsFrustumCullingVolume::ODRX_DECLARE_MEMBERS ( OdGsFrustumCullingVolume  )

The documentation for this class was generated from the following file: