camera.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 2008 Autodesk, Inc.
// All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
//
//**************************************************************************/
// DESCRIPTION:
// CREATED: October 2008
//**************************************************************************/

namespace mudbox {

class MBDLL_DECL Camera : virtual public GroupNode
{
    DECLARE_CLASS;

protected:
    Camera( void );

public:

    virtual Vector Forward( void ) const;

    virtual Vector Up( void ) const;

    virtual Vector Right( void ) const;

    virtual float Yaw( void ) const;

    virtual float Pitch( void ) const;

    virtual float Roll( void ) const;

    virtual Vector Position( void ) const;

    virtual void SetYawPitchRoll(
        const Vector &vYPR      
        );

    virtual void AddYawPitchRoll(
        const Vector &vYPR      
        );

    virtual void SetForwardUpRight(
        const Vector &vForward,     
        const Vector &vUp,          
        const Vector &vRight        
        );

    virtual void SetTarget(
        const Vector &vTarget,                      
        const Vector &vUpDir = Vector( 0, 1, 0 )    
        );

    virtual void SetPosition(
        const Vector &vPosition     
        );

    virtual void MoveForward(
        float fRange    
        );

    virtual void MoveUp(
        float fRange    
        );

    virtual void MoveRight(
        float fRange    
        );

    virtual void MoveBackward(
        float fRange    
        );

    virtual void MoveDown(
        float fRange    
        );

    virtual void MoveLeft(
        float fRange    
        );

    virtual Vector Project(
        const Vector &vWorldPosition    
        ) const;

    virtual Vector UnProject(
        const Vector &vScreenPosition   
        ) const;

    virtual mudbox::Matrix Matrix(
        bool bOffscreen = false     
        ) const;

    virtual float FOV( void ) const;

    virtual float Near( void ) const;

    virtual float Far( void ) const;

    virtual float AspectRatio( void ) const;

    virtual void SetFOV(
        float fFOV          
        );

    virtual void SetNear(
        float fNear     
        );

    virtual void SetFar(
        float fFar  
        );

    virtual void SetAspectRatio(
        float fAspectRatio  
        );

    virtual float Scale2D( void ) const;

    virtual float Angle2D( void ) const;

    virtual Vector Position2D( void ) const;

    virtual void SetScale2D(
        float fScale2D      
        );

    virtual void SetAngle2D(
        float fAngle2D      
        );

    virtual void SetPosition2D(
        const Vector &vPosition2D   
        );

    virtual void CopyFrom(
        const Camera &cOther    
        );


    virtual bool IsEqualTo(
        const Camera &cOther    
        ) const;

    virtual bool Pick(
        float fXPosition,       
        float fYPosition,       
        SurfacePoint &sResult   
        );

    virtual ScreenSpacePicker *GetScreenSpacePicker() const; 

    virtual Vector Aim() const;
    
    virtual void SetAim(
        const Vector &v     
        );
    
    virtual bool Orthographic() const;
    
    virtual void SetOrthographic(
        bool isOrtho        
        );

    virtual bool IsDirty( void ) const;

    virtual void SetDirty( bool bDirty );
};

}; // end of namespace mudbox