From 393b5cd1dc438872af89d334ef6e5fcc59f27d47 Mon Sep 17 00:00:00 2001 From: David Walter Seikel Date: Sun, 13 Jan 2013 17:24:39 +1000 Subject: Added Irrlicht 1.8, but without all the Windows binaries. --- .../structirr_1_1scene_1_1_s_view_frustum.html | 710 +++++++++++++++++++++ 1 file changed, 710 insertions(+) create mode 100644 libraries/irrlicht-1.8/doc/html/structirr_1_1scene_1_1_s_view_frustum.html (limited to 'libraries/irrlicht-1.8/doc/html/structirr_1_1scene_1_1_s_view_frustum.html') diff --git a/libraries/irrlicht-1.8/doc/html/structirr_1_1scene_1_1_s_view_frustum.html b/libraries/irrlicht-1.8/doc/html/structirr_1_1scene_1_1_s_view_frustum.html new file mode 100644 index 0000000..e10de11 --- /dev/null +++ b/libraries/irrlicht-1.8/doc/html/structirr_1_1scene_1_1_s_view_frustum.html @@ -0,0 +1,710 @@ + + + + +Irrlicht 3D Engine: irr::scene::SViewFrustum Struct Reference + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + +
+
Irrlicht 3D Engine + +
+ +
+ + + + + + +
+
+
+ + + + +
+
+ +
+
+
+ +
+
+
+Public Types | +Public Member Functions | +Public Attributes
+
+
irr::scene::SViewFrustum Struct Reference
+
+
+ +

Defines the view frustum. That's the space visible by the camera. + More...

+ +

#include <SViewFrustum.h>

+ +

List of all members.

+

+Public Types

+ +

+Public Member Functions

+ +

+Public Attributes

+ +

Detailed Description

+

Defines the view frustum. That's the space visible by the camera.

+

The view frustum is enclosed by 6 planes. These six planes share eight points. A bounding box around these eight points is also stored in this structure.

+ +

Definition at line 25 of file SViewFrustum.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum irr::scene::SViewFrustum::VFPLANES
+
+
+
Enumerator:
+ + + + + + + +
VF_FAR_PLANE  +

Far plane of the frustum. That is the plane farest away from the eye.

+
VF_NEAR_PLANE  +

Near plane of the frustum. That is the plane nearest to the eye.

+
VF_LEFT_PLANE  +

Left plane of the frustum.

+
VF_RIGHT_PLANE  +

Right plane of the frustum.

+
VF_BOTTOM_PLANE  +

Bottom plane of the frustum.

+
VF_TOP_PLANE  +

Top plane of the frustum.

+
VF_PLANE_COUNT  +

Amount of planes enclosing the view frustum. Should be 6.

+
+
+
+ +

Definition at line 27 of file SViewFrustum.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
irr::scene::SViewFrustum::SViewFrustum () [inline]
+
+
+ +

Default Constructor.

+ +

Definition at line 48 of file SViewFrustum.h.

+ +
+
+ +
+
+ + + + + + + + +
irr::scene::SViewFrustum::SViewFrustum (const SViewFrustum & other) [inline]
+
+
+ +

Copy Constructor.

+

Copy constructor ViewFrustum

+ +

Definition at line 129 of file SViewFrustum.h.

+ +

References boundingBox, cameraPosition, planes, and VF_PLANE_COUNT.

+ +
+
+ +
+
+ + + + + + + + +
irr::scene::SViewFrustum::SViewFrustum (const core::matrix4 & mat) [inline]
+
+
+ +

This constructor creates a view frustum based on a projection and/or view matrix.

+ +

Definition at line 142 of file SViewFrustum.h.

+ +

References setFrom().

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
bool irr::scene::SViewFrustum::clipLine (core::line3d< f32 > & line) const [inline]
+
+
+ +

clips a line to the view frustum.

+

Clips a line to the frustum.

+
Returns:
True if the line was clipped, false if not
+ +

Definition at line 344 of file SViewFrustum.h.

+ +

References irr::core::line3d< T >::end, irr::core::plane3d< T >::getKnownIntersectionWithLine(), irr::core::ISREL3D_FRONT, planes, irr::core::line3d< T >::start, and VF_PLANE_COUNT.

+ +
+
+ +
+
+ + + + + + + +
const core::aabbox3d< f32 > & irr::scene::SViewFrustum::getBoundingBox () const [inline]
+
+
+ +

returns a bounding box enclosing the whole view frustum

+ +

Definition at line 238 of file SViewFrustum.h.

+ +

References boundingBox.

+ +
+
+ +
+
+ + + + + + + +
core::vector3df irr::scene::SViewFrustum::getFarLeftDown () const [inline]
+
+
+ +

returns the point which is on the far left bottom corner inside the the view frustum.

+ +

Definition at line 168 of file SViewFrustum.h.

+ +

References irr::core::plane3d< T >::getIntersectionWithPlanes(), planes, VF_BOTTOM_PLANE, VF_FAR_PLANE, and VF_LEFT_PLANE.

+ +

Referenced by recalculateBoundingBox().

+ +
+
+ +
+
+ + + + + + + +
core::vector3df irr::scene::SViewFrustum::getFarLeftUp () const [inline]
+
+
+ +

returns the point which is on the far left upper corner inside the the view frustum.

+ +

Definition at line 158 of file SViewFrustum.h.

+ +

References irr::core::plane3d< T >::getIntersectionWithPlanes(), planes, VF_FAR_PLANE, VF_LEFT_PLANE, and VF_TOP_PLANE.

+ +

Referenced by recalculateBoundingBox().

+ +
+
+ +
+
+ + + + + + + +
core::vector3df irr::scene::SViewFrustum::getFarRightDown () const [inline]
+
+
+ +

returns the point which is on the far right bottom corner inside the the view frustum.

+ +

Definition at line 188 of file SViewFrustum.h.

+ +

References irr::core::plane3d< T >::getIntersectionWithPlanes(), planes, VF_BOTTOM_PLANE, VF_FAR_PLANE, and VF_RIGHT_PLANE.

+ +

Referenced by recalculateBoundingBox().

+ +
+
+ +
+
+ + + + + + + +
core::vector3df irr::scene::SViewFrustum::getFarRightUp () const [inline]
+
+
+ +

returns the point which is on the far right top corner inside the the view frustum.

+ +

Definition at line 178 of file SViewFrustum.h.

+ +

References irr::core::plane3d< T >::getIntersectionWithPlanes(), planes, VF_FAR_PLANE, VF_RIGHT_PLANE, and VF_TOP_PLANE.

+ +

Referenced by recalculateBoundingBox().

+ +
+
+ +
+
+ + + + + + + +
core::vector3df irr::scene::SViewFrustum::getNearLeftDown () const [inline]
+
+
+ +

returns the point which is on the near left bottom corner inside the the view frustum.

+ +

Definition at line 208 of file SViewFrustum.h.

+ +

References irr::core::plane3d< T >::getIntersectionWithPlanes(), planes, VF_BOTTOM_PLANE, VF_LEFT_PLANE, and VF_NEAR_PLANE.

+ +
+
+ +
+
+ + + + + + + +
core::vector3df irr::scene::SViewFrustum::getNearLeftUp () const [inline]
+
+
+ +

returns the point which is on the near left upper corner inside the the view frustum.

+ +

Definition at line 198 of file SViewFrustum.h.

+ +

References irr::core::plane3d< T >::getIntersectionWithPlanes(), planes, VF_LEFT_PLANE, VF_NEAR_PLANE, and VF_TOP_PLANE.

+ +
+
+ +
+
+ + + + + + + +
core::vector3df irr::scene::SViewFrustum::getNearRightDown () const [inline]
+
+
+ +

returns the point which is on the near right bottom corner inside the the view frustum.

+ +

Definition at line 228 of file SViewFrustum.h.

+ +

References irr::core::plane3d< T >::getIntersectionWithPlanes(), planes, VF_BOTTOM_PLANE, VF_NEAR_PLANE, and VF_RIGHT_PLANE.

+ +
+
+ +
+
+ + + + + + + +
core::vector3df irr::scene::SViewFrustum::getNearRightUp () const [inline]
+
+
+ +

returns the point which is on the near right top corner inside the the view frustum.

+ +

Definition at line 218 of file SViewFrustum.h.

+ +

References irr::core::plane3d< T >::getIntersectionWithPlanes(), planes, VF_NEAR_PLANE, VF_RIGHT_PLANE, and VF_TOP_PLANE.

+ +
+
+ +
+
+ + + + + + + + +
core::matrix4 & irr::scene::SViewFrustum::getTransform (video::E_TRANSFORMATION_STATE state) [inline]
+
+
+ +

get the given state's matrix based on frustum E_TRANSFORMATION_STATE

+

View Frustum depends on Projection & View Matrix

+ +

Definition at line 310 of file SViewFrustum.h.

+ +

References irr::video::ETS_PROJECTION, and irr::video::ETS_VIEW.

+ +
+
+ +
+
+ + + + + + + + +
const core::matrix4 & irr::scene::SViewFrustum::getTransform (video::E_TRANSFORMATION_STATE state) const [inline]
+
+
+ +

get the given state's matrix based on frustum E_TRANSFORMATION_STATE

+

View Frustum depends on Projection & View Matrix

+ +

Definition at line 328 of file SViewFrustum.h.

+ +

References irr::video::ETS_PROJECTION, and irr::video::ETS_VIEW.

+ +
+
+ +
+
+ + + + + + + +
void irr::scene::SViewFrustum::recalculateBoundingBox () [inline]
+
+
+ +

recalculates the bounding box member based on the planes

+ +

Definition at line 243 of file SViewFrustum.h.

+ +

References irr::core::aabbox3d< T >::addInternalPoint(), boundingBox, cameraPosition, getFarLeftDown(), getFarLeftUp(), getFarRightDown(), getFarRightUp(), and irr::core::aabbox3d< T >::reset().

+ +

Referenced by setFrom(), and transform().

+ +
+
+ +
+
+ + + + + + + + +
void irr::scene::SViewFrustum::setFrom (const core::matrix4 & mat) [inline]
+
+
+ +

This constructor creates a view frustum based on a projection and/or view matrix.

+ +

Definition at line 255 of file SViewFrustum.h.

+ +

References irr::core::plane3d< T >::D, irr::core::plane3d< T >::Normal, planes, recalculateBoundingBox(), irr::core::reciprocal_squareroot(), VF_BOTTOM_PLANE, VF_FAR_PLANE, VF_LEFT_PLANE, VF_NEAR_PLANE, VF_PLANE_COUNT, VF_RIGHT_PLANE, and VF_TOP_PLANE.

+ +

Referenced by SViewFrustum().

+ +
+
+ +
+
+ + + + + + + + +
void irr::scene::SViewFrustum::transform (const core::matrix4 & mat) [inline]
+
+
+ +

transforms the frustum by the matrix

+
Parameters:
+ + +
mat,:Matrix by which the view frustum is transformed.
+
+
+ +

Definition at line 148 of file SViewFrustum.h.

+ +

References cameraPosition, planes, recalculateBoundingBox(), irr::core::CMatrix4< T >::transformPlane(), irr::core::CMatrix4< T >::transformVect(), and VF_PLANE_COUNT.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
core::aabbox3d<f32> irr::scene::SViewFrustum::boundingBox
+
+
+ +

bounding box around the view frustum

+ +

Definition at line 110 of file SViewFrustum.h.

+ +

Referenced by getBoundingBox(), recalculateBoundingBox(), and SViewFrustum().

+ +
+
+ +
+
+ + + + +
core::vector3df irr::scene::SViewFrustum::cameraPosition
+
+
+ +

the position of the camera

+ +

Definition at line 104 of file SViewFrustum.h.

+ +

Referenced by recalculateBoundingBox(), SViewFrustum(), and transform().

+ +
+
+ +
+
+ + + + +
core::plane3d<f32> irr::scene::SViewFrustum::planes[VF_PLANE_COUNT]
+
+
+ +

all planes enclosing the view frustum.

+ +

Definition at line 107 of file SViewFrustum.h.

+ +

Referenced by clipLine(), getFarLeftDown(), getFarLeftUp(), getFarRightDown(), getFarRightUp(), getNearLeftDown(), getNearLeftUp(), getNearRightDown(), getNearRightUp(), setFrom(), SViewFrustum(), and transform().

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + + -- cgit v1.1