S60 3rd Edition SDK for Symbian OS Example Applications Guide

lensflare.h

/*
* ==============================================================================
*  Name        : LensFlare.h
*  Part of     : OpenGLEx / LensFlare
*  Interface   : 
*  Description : 
*  Version     : 
*
*  Copyright (c) 2004-2006 Nokia Corporation.
*  This material, including documentation and any related 
*  computer programs, is protected by copyright controlled by 
*  Nokia Corporation.
* ==============================================================================
*/

#ifndef __LENSFLAREH__
#define __LENSFLAREH__

// INCLUDES
#include <e32base.h> // for CBase definition
#include <GLES\gl.h> // OpenGL ES header file
#include "utils.h"

// CONSTANTS

// MACROS
#define FRUSTUM_LEFT   -1.f     //left vertical clipping plane
#define FRUSTUM_RIGHT  +1.f     //right vertical clipping plane
#define FRUSTUM_BOTTOM -1.f     //bottom horizontal clipping plane
#define FRUSTUM_TOP    +1.f     //top horizontal clipping plane
#define FRUSTUM_NEAR   +3.f     //near depth clipping plane
#define FRUSTUM_FAR    +1000.f  //far depth clipping plane

// DATA TYPES

// FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

// CLASS DECLARATION

/**
 * Class that does the actual OpenGL ES rendering.
 * Subclass of CFiniteStateMachine because the application
 * needs to handle loading textures and running states.
 */
class CLensflare : public CFiniteStateMachine, public MTextureLoadingListener
        {
        public:

        /**
         * Factory method for creating a new CLensflare object.
         */
                static CLensflare* NewL( TUint aWidth, TUint aHeight);

        /**
         * Destructor. Does nothing.
         */
                virtual ~CLensflare();

        public: // New functions

        /**
         * Initializes OpenGL ES, sets the vertex and color
         * arrays and pointers. Also selects the shading mode and
         * creates the CTextureManager instance and starts loading
         * of required textures.
         */
                void AppInitL( void );

        /**
         * Called upon application exit. Destroys the CTextureManager
         * instance that was created in AppInitL() method.
         */
                void AppExit( void );

        /**
         * Renders one frame.
         * @param aFrame Number of the frame to be rendered.
         */
                void AppCycle( TInt aFrame );

        /**
         * Called when the finite state machine enters a new state.
         * Gets the current time that is then used as the starting time.
         * @param aState State that is about to be entered.
         */
                void OnEnterStateL( TInt aState );

        /**
         * Called when texture manager starts loading the textures.
         * Sets the current state to "loading textures".
         */
                void OnStartLoadingTexturesL();

        /**
         * Called when texture manager has completed texture loading.
         * Changes the current state to "running".
         */
                void OnEndLoadingTexturesL();

                /**
                 * Draw the 'NokiaGL' text.
                 * @param aReflection Flag that specifies if we are drawing the reflected text or not.
                 */
                void DrawText(TBool aReflection);

                /**
                 * Draw the ground plane.
                 */
                void DrawPlane();


                /**
                 * Returns the current system time.
                 * @return Current system time
                 */
                TTime GetTimeTick(); 

                /**
                 * Returns the ellapsed time (in seconds) between the current and the previous frame.
                 * @return iElapsedTime Elapsed time between frames in seconds.
                 */
                GLfloat GetElapsedTime();

                /**
                 * Returns the current frames per second rate.
                 * @return iFPSCount Current frame rate.
                 */
                GLfloat GetFPSCount();

                /**
                 * Move the camera from/to the origin.
                 * @param aDirection Direction to move camera.
                 * @param aTime Time.
                 */
                void MoveCamera(GLint aDirection, GLfloat aTime = 0);

                /**
                 * Turn the camera in azimuth.
                 * @param aDirection Direction to turn camera
                 * @param aTime Time
                 */
                void TurnCameraAzimuth(GLint aDirection, GLfloat aTime = 0);

                /**
                 * Change the camera elevation.
                 * @param aDirection Direction to turn camera
                 * @param aTime Time.
                 */
                void TurnCameraElevation(GLint aDirection, GLfloat aTime = 0);

        /**
         * Notifies that the screen size has dynamically changed during execution of
         * this program. Resets the viewport to this new size and sets this size
         * to the CTextureManager.
         * @param aWidth New width of the screen.
         * @param aHeight New height of the screen.
         */
        void SetScreenSize( TUint aWidth, TUint aHeight );

        protected:

        /**
         * Standard constructor that must never Leave.
         * Stores the given screen width and height.
         * @param aWidth Width of the screen.
         * @param aHeight Height of the screen.
         */
                CLensflare( TUint aWidth, TUint aHeight );

        /**
         * Second phase contructor. Does nothing.
         */
                void ConstructL( void );

        public: // Data

        /**
         * Application states:
         * ELoadingTextures - indicates that the app. is loading textures.
         * ERunning - indicates that the app. is running.
         */
                enum 
                        {
                        ELoadingTextures, 
                        ERunning
                        };
    

                /** Camera movement direction. */
                GLbyte iDirection;

        private: // Data

        /** Texture manager that is used to load the used textures. */
                CTextureManager * iTextureManager;
        /** Width of the screen */
        TUint iScreenWidth;
        /** Height of the screen */
        TUint iScreenHeight;

                /** Lens-flare effect. */
                CLensFlareEffect * iLensFlareEffect;

                /** Trigonometric functions lookup-table. */
                CLookUpTable * iLookUpTable;

                /** Camera. */
                TCamera iCamera;
                
                /** Delta time measurement start. */
                TTime iT0;
                /** Delta time measurement end. */
                TTime iT1;
                /** Elapsed time == delta. */
                GLfloat iElapsedTime;
                /** Rendered frames per second. */
                GLfloat iFPSCount;
                /** Azimuth angle for camera. */
                GLfloat iAzimuth;
                /** Elevation angle for camera. */
                GLfloat iElevation;
                /** Camera distance. */
                GLfloat iDistance;
                /** Angle of the lensflare effect. */
                GLfloat iLensAngle;
                /** Lens radius. */
                GLfloat iLensRadius;

        };

#endif

// End of File

---

© Nokia 2006