##########
IViewpoint
##########

.. cpp:namespace:: RED::IViewpoint

.. default-domain:: cpp

Functions
=========

================================================================================= ======================================================================================================================================================================================================================
:doc:`classRED_1_1CID`                                                            :cpp:func:`GetClassID <static RED::CID RED::IViewpoint::GetClassID()>`                                                                                                                                                
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetLinkedWindows <virtual RED_RC RED::IViewpoint::GetLinkedWindows(RED::Vector< RED::Object * > &oWindowList, int iStateNumber=-1) const =0>`                                                              
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetViewingAxis <virtual RED_RC RED::IViewpoint::GetViewingAxis(RED::Vector3 &oSight, RED::Vector3 &oTop, RED::Vector3 &oRight, int iStateNumber=-1) const =0>`                                             
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetViewingAxis <virtual RED_RC RED::IViewpoint::SetViewingAxis(const RED::Vector3 &iSight, const RED::Vector3 &iTop, const RED::Vector3 &iRight, const RED::State &iState)=0>`                             
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetViewingMatrix <virtual RED_RC RED::IViewpoint::SetViewingMatrix(const RED::Matrix &iMatrix, const RED::State &iState)=0>`                                                                               
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetEye <virtual RED_RC RED::IViewpoint::GetEye(RED::Vector3 &oEye, int iStateNumber=-1) const =0>`                                                                                                         
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFloatingEye <virtual RED_RC RED::IViewpoint::GetFloatingEye(RED::Vector3 &oEye, int iStateNumber=-1) const =0>`                                                                                         
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetSight <virtual RED_RC RED::IViewpoint::GetSight(RED::Vector3 &oSight, int iStateNumber=-1) const =0>`                                                                                                   
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFloatingSight <virtual RED_RC RED::IViewpoint::GetFloatingSight(RED::Vector3 &oSight, int iStateNumber=-1) const =0>`                                                                                   
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetTop <virtual RED_RC RED::IViewpoint::GetTop(RED::Vector3 &oTop, int iStateNumber=-1) const =0>`                                                                                                         
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFloatingTop <virtual RED_RC RED::IViewpoint::GetFloatingTop(RED::Vector3 &oTop, int iStateNumber=-1) const =0>`                                                                                         
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetRight <virtual RED_RC RED::IViewpoint::GetRight(RED::Vector3 &oRight, int iStateNumber=-1) const =0>`                                                                                                   
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFloatingRight <virtual RED_RC RED::IViewpoint::GetFloatingRight(RED::Vector3 &oRight, int iStateNumber=-1) const =0>`                                                                                   
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetEye <virtual RED_RC RED::IViewpoint::SetEye(const RED::Vector3 &iEye, const RED::State &iState)=0>`                                                                                                     
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetSight <virtual RED_RC RED::IViewpoint::SetSight(const RED::Vector3 &iSight, const RED::State &iState)=0>`                                                                                               
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetTop <virtual RED_RC RED::IViewpoint::SetTop(const RED::Vector3 &iTop, const RED::State &iState)=0>`                                                                                                     
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetRight <virtual RED_RC RED::IViewpoint::SetRight(const RED::Vector3 &iRight, const RED::State &iState)=0>`                                                                                               
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetViewingMatrix <virtual RED_RC RED::IViewpoint::GetViewingMatrix(RED::Matrix &oMatrix, int iStateNumber=-1) const =0>`                                                                                   
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFloatingViewingMatrix <virtual RED_RC RED::IViewpoint::GetFloatingViewingMatrix(RED::Matrix &oMatrix, int iStateNumber=-1) const =0>`                                                                   
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetInvertViewingMatrix <virtual RED_RC RED::IViewpoint::GetInvertViewingMatrix(RED::Matrix &oMatrix, int iStateNumber=-1) const =0>`                                                                       
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFloatingInvertViewingMatrix <virtual RED_RC RED::IViewpoint::GetFloatingInvertViewingMatrix(RED::Matrix &oMatrix, int iStateNumber=-1) const =0>`                                                       
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetViewProjectionMatrix <virtual RED_RC RED::IViewpoint::GetViewProjectionMatrix(RED::Matrix &oMatrix, int iStateNumber=-1) const =0>`                                                                     
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFloatingViewProjectionMatrix <virtual RED_RC RED::IViewpoint::GetFloatingViewProjectionMatrix(RED::Matrix &oMatrix, int iStateNumber=-1) const =0>`                                                     
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetProjectionMatrix <virtual RED_RC RED::IViewpoint::GetProjectionMatrix(RED::Matrix &oMatrix, int iStateNumber=-1) const =0>`                                                                             
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetNearFar <virtual RED_RC RED::IViewpoint::GetNearFar(double &oDNear, double &oDFar, int iStateNumber=-1) const =0>`                                                                                      
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetNearFar <virtual RED_RC RED::IViewpoint::GetNearFar(float &oDNear, float &oDFar, int iStateNumber=-1) const =0>`                                                                                        
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetNearFar <virtual RED_RC RED::IViewpoint::SetNearFar(double iDnear, double iDFar, const RED::State &iState)=0>`                                                                                          
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetProjection <virtual RED_RC RED::IViewpoint::GetProjection(RED::VIEWPOINT_TYPE &oProj, int iStateNumber=-1) const =0>`                                                                                   
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetProjection <virtual RED_RC RED::IViewpoint::SetProjection(RED::VIEWPOINT_TYPE iProjection, const RED::State &iState)=0>`                                                                                
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`IsAsymmetric <virtual RED_RC RED::IViewpoint::IsAsymmetric(bool &oAsym, int iStateNumber=-1) const =0>`                                                                                                    
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFrustumPerspective <virtual RED_RC RED::IViewpoint::GetFrustumPerspective(double &oFov, double &oRatio, int iStateNumber=-1) const =0>`                                                                 
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFrustumPerspective <virtual RED_RC RED::IViewpoint::GetFrustumPerspective(float &oFov, float &oRatio, int iStateNumber=-1) const =0>`                                                                   
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetFrustumPerspective <virtual RED_RC RED::IViewpoint::SetFrustumPerspective(double iFov, double iRatio, const RED::State &iState)=0>`                                                                     
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetAsymmetricFrustumPerspective <virtual RED_RC RED::IViewpoint::GetAsymmetricFrustumPerspective(double &oFovLeft, double &oFovRight, double &oFovBottom, double &oFovTop, int iStateNumber=-1) const =0>` 
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetAsymmetricFrustumPerspective <virtual RED_RC RED::IViewpoint::GetAsymmetricFrustumPerspective(float &oFovLeft, float &oFovRight, float &oFovBottom, float &oFovTop, int iStateNumber=-1) const =0>`     
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetAsymmetricFrustumPerspective <virtual RED_RC RED::IViewpoint::SetAsymmetricFrustumPerspective(double iFovLeft, double iFovRight, double iFovBottom, double iFovTop, const RED::State &iState)=0>`       
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFrustumParallel <virtual RED_RC RED::IViewpoint::GetFrustumParallel(double &oXSiz, double &oYSiz, int iStateNumber=-1) const =0>`                                                                       
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFrustumParallel <virtual RED_RC RED::IViewpoint::GetFrustumParallel(float &oXSiz, float &oYSiz, int iStateNumber=-1) const =0>`                                                                         
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetFrustumParallel <virtual RED_RC RED::IViewpoint::SetFrustumParallel(double iXSiz, double iYSiz, const RED::State &iState)=0>`                                                                           
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetAsymmetricFrustumParallel <virtual RED_RC RED::IViewpoint::GetAsymmetricFrustumParallel(double &oXLeft, double &oXRight, double &oYBottom, double &oYTop, int iStateNumber=-1) const =0>`               
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetAsymmetricFrustumParallel <virtual RED_RC RED::IViewpoint::GetAsymmetricFrustumParallel(float &oXLeft, float &oXRight, float &oYBottom, float &oYTop, int iStateNumber=-1) const =0>`                   
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetAsymmetricFrustumParallel <virtual RED_RC RED::IViewpoint::SetAsymmetricFrustumParallel(double iXLeft, double iXRight, double iYBottom, double iYTop, const RED::State &iState)=0>`                     
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetForScreenDraw <virtual RED_RC RED::IViewpoint::SetForScreenDraw(double iWidth, double iHeight, double iZMin, double iZMax, const RED::State &iState)=0>`                                                
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFrustum <virtual RED_RC RED::IViewpoint::GetFrustum(double &oLeft, double &oRight, double &oBottom, double &oTop, double &oNear, double &oFar, int iStateNumber=- 1) const =0>`                         
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFrustum <virtual RED_RC RED::IViewpoint::GetFrustum(float &oLeft, float &oRight, float &oBottom, float &oTop, float &oNear, float &oFar, int iStateNumber=- 1) const =0>`                               
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetFrustumCustom <virtual RED_RC RED::IViewpoint::SetFrustumCustom(const RED::Matrix &iMatrix, const RED::State &iState)=0>`                                                                               
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFrustumCustom <virtual RED_RC RED::IViewpoint::GetFrustumCustom(RED::Matrix &oMatrix, int iStateNumber=-1) const =0>`                                                                                   
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetCustomClipPlanes <virtual RED_RC RED::IViewpoint::SetCustomClipPlanes(double iA[6], double iB[6], double iC[6], double iD[6], const RED::State &iState)=0>`                                             
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetClipPlanes <virtual RED_RC RED::IViewpoint::GetClipPlanes(double oA[6], double oB[6], double oC[6], double oD[6], int iStateNumber=-1) const =0>`                                                       
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`TranslateEye <virtual RED_RC RED::IViewpoint::TranslateEye(const RED::Vector3 &iOffset, const RED::State &iState)=0>`                                                                                      
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`RotateAroundEye <virtual RED_RC RED::IViewpoint::RotateAroundEye(double iPitchOffset, double iYawOffset, double iRollOffset, const RED::State &iState)=0>`                                                 
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFocusDistance <virtual RED_RC RED::IViewpoint::GetFocusDistance(double &oFocus, int iStateNumber=-1) const =0>`                                                                                         
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFocusDistance <virtual RED_RC RED::IViewpoint::GetFocusDistance(float &oFocus, int iStateNumber=-1) const =0>`                                                                                          
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetFocusDistance <virtual RED_RC RED::IViewpoint::SetFocusDistance(double iDistance, const RED::State &iState)=0>`                                                                                         
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`RotateAroundFocus <virtual RED_RC RED::IViewpoint::RotateAroundFocus(double iPitchOffset, double iYawOffset, double iRollOffset, const RED::State &iState)=0>`                                             
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`ZoomOnFocus <virtual RED_RC RED::IViewpoint::ZoomOnFocus(double iZoomingFactor, const RED::State &iState)=0>`                                                                                              
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`TranslateWithFocus <virtual RED_RC RED::IViewpoint::TranslateWithFocus(const RED::Vector3 &iNewFocus, const RED::State &iState)=0>`                                                                        
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetRootShape <virtual RED_RC RED::IViewpoint::GetRootShape(RED::Object *&oRoot, int iStateNumber=-1) const =0>`                                                                                            
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`AddShape <virtual RED_RC RED::IViewpoint::AddShape(RED::Object *iShape, const RED::State &iState)=0>`                                                                                                      
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`RemoveShape <virtual RED_RC RED::IViewpoint::RemoveShape(RED::Object *iShape, const RED::State &iState)=0>`                                                                                                
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`ApplyLayerSet <virtual RED_RC RED::IViewpoint::ApplyLayerSet(const RED::LayerSet &iLayerSet, const RED::State &iState)=0>`                                                                                 
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetLayerSet <virtual RED_RC RED::IViewpoint::GetLayerSet(RED::LayerSet &oLayerSet, int iStateNumber=-1) const =0>`                                                                                         
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetInstanceCounterCallback <virtual RED_RC RED::IViewpoint::SetInstanceCounterCallback(RED::INSTANCE_COUNTER_CALLBACK iCallback, void *iUserData, const RED::State &iState)=0>`                            
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetInstanceCounterCallback <virtual RED_RC RED::IViewpoint::GetInstanceCounterCallback(RED::INSTANCE_COUNTER_CALLBACK &oCallback, void *&oUserData, int iStateNumber=- 1) const =0>`                       
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetInstanceCounterImageCallback <virtual RED_RC RED::IViewpoint::SetInstanceCounterImageCallback(RED::INSTANCE_COUNTER_IMAGE_CALLBACK iCallback, void *iUserData, const RED::State &iState)=0>`            
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetInstanceCounterImageCallback <virtual RED_RC RED::IViewpoint::GetInstanceCounterImageCallback(RED::INSTANCE_COUNTER_IMAGE_CALLBACK &oCallback, void *&oUserData, int iStateNumber=- 1) const =0>`       
:doc:`classRED_1_1PostProcess` &                                                  :cpp:func:`GetPostProcessSettings <virtual RED::PostProcess & RED::IViewpoint::GetPostProcessSettings()=0>`                                                                                                           
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`AddRenderShaderParameter <virtual RED_RC RED::IViewpoint::AddRenderShaderParameter(int iIndex, const RED::RenderShaderParameter &iParam, const RED::State &iState)=0>`                                     
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`RemoveRenderShaderParameter <virtual RED_RC RED::IViewpoint::RemoveRenderShaderParameter(int iIndex, const RED::State &iState)=0>`                                                                         
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetRenderShaderParameter <virtual RED_RC RED::IViewpoint::GetRenderShaderParameter(RED::RenderShaderParameter &oParam, int iIndex, int iStateNumber=-1) const =0>`                                         
const :doc:`classRED_1_1Map` < int, :doc:`classRED_1_1RenderShaderParameter` > &  :cpp:func:`GetRenderShaderParameters <virtual const RED::Map< int, RED::RenderShaderParameter > & RED::IViewpoint::GetRenderShaderParameters(int iStateNumber=-1) const =0>`                                          
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`SetFloatingOrigin <virtual RED_RC RED::IViewpoint::SetFloatingOrigin(const RED::Matrix &iMatx, const RED::State &iState)=0>`                                                                               
:cpp:enumerator:`~RED_RC`                                                         :cpp:func:`GetFloatingOrigin <virtual RED_RC RED::IViewpoint::GetFloatingOrigin(RED::Matrix &oMatx, int iStateNumber=-1) const =0>`                                                                                   
================================================================================= ======================================================================================================================================================================================================================

.. cpp:namespace:: nullptr

Detailed Description
====================

.. doxygenclass:: RED::IViewpoint
   :project: RED
   :members:
   :undoc-members:



