ICF 3.0.5.47
Technical documentation of ICF Libraries
i2d::ISceneController Class Referenceabstract

Interface for scene manipulation and query the restrictions. More...

#include <ISceneController.h>

Inheritance diagram for i2d::ISceneController:
Collaboration diagram for i2d::ISceneController:

Public Types

enum  RestrictionFlags {
  SR_NONE = 0x0 , SR_ROTATE = 0x1 , SR_SHIFT = 0x2 , SR_SCALE = 0x4 ,
  SR_ALL = 0xff
}
 
enum  FittingMode { FM_NONE , FM_ISOTROPIC_REDUCTION , FM_ISOTROPIC , FM_ANISOTROPIC }
 Vieport scale fitting mode. More...
 
enum  ScaleMode {
  SM_SET , SM_COMBINE , SM_RESET , SM_ZOOM_IN ,
  SM_ZOOM_OUT , SM_FIT_ISOTROPIC_REDUCTION , SM_FIT_ISOTROPIC , SM_FIT_ANISOTROPIC
}
 Describe mode for setting of scale value. More...
 

Public Member Functions

virtual int GetSceneRestrictionFlags () const =0
 Get the restriction flags, to tell the scene manipulator, what can be changed on the scene.
 
virtual FittingMode GetFitMode () const =0
 Get vieport scale fitting mode.
 
virtual bool SetFitMode (FittingMode fitMode)=0
 Set vieport scale fitting mode.
 
virtual bool IsFullScreenMode () const =0
 Check if full screen mode is enabled.
 
virtual bool SetFullScreenMode (bool isFullScreen)=0
 Set full screen mode on/off.
 
virtual double GetScale () const =0
 Get actual scale factor.
 
virtual bool SetScale (int scaleMode=SM_SET, double value=1.0)=0
 Set or modify scale factor.
 

Detailed Description

Interface for scene manipulation and query the restrictions.

Definition at line 21 of file ISceneController.h.

Member Enumeration Documentation

◆ FittingMode

Vieport scale fitting mode.

Enumerator
FM_NONE 

No fitting will be done.

FM_ISOTROPIC_REDUCTION 

Isotropic scale will be done, but only scale reduction is allowed.

FM_ISOTROPIC 

Complete isotropic scale will be done.

FM_ANISOTROPIC 

Anisotropic scale will be done to fit whole viewport area.

Definition at line 55 of file ISceneController.h.

◆ RestrictionFlags

Enumerator
SR_NONE 

All operations on scene object are allowed.

SR_ROTATE 

Rotation operaration is prohibited.

SR_SHIFT 

Translation operaration is prohibited.

SR_SCALE 

Translation operaration is prohibited.

SR_ALL 

All operations on scene object are prohibited.

Definition at line 24 of file ISceneController.h.

◆ ScaleMode

Describe mode for setting of scale value.

Enumerator
SM_SET 

Simple set, old scale will be replaced with the new value.

SM_COMBINE 

Old scale will be mutliplied by the new value.

SM_RESET 

Zoom will be reset, parameter value will be ignored.

SM_ZOOM_IN 

Zoom in will be done, parameter value will be ignored.

SM_ZOOM_OUT 

Zoom out will be done, parameter value will be ignored.

SM_FIT_ISOTROPIC_REDUCTION 

Isotropic scale will be done, but only scale reduction is allowed.

SM_FIT_ISOTROPIC 

Complete isotropic scale will be done.

SM_FIT_ANISOTROPIC 

Anisotropic scale will be done to fit whole viewport area.

Definition at line 77 of file ISceneController.h.

Member Function Documentation

◆ GetFitMode()

virtual FittingMode i2d::ISceneController::GetFitMode ( ) const
pure virtual

Get vieport scale fitting mode.

Implemented in icmpstr::CSceneProviderGuiComp.

◆ GetScale()

virtual double i2d::ISceneController::GetScale ( ) const
pure virtual

Get actual scale factor.

Implemented in icmpstr::CSceneProviderGuiComp.

◆ GetSceneRestrictionFlags()

virtual int i2d::ISceneController::GetSceneRestrictionFlags ( ) const
pure virtual

Get the restriction flags, to tell the scene manipulator, what can be changed on the scene.

Implemented in icmpstr::CSceneProviderGuiComp.

◆ IsFullScreenMode()

virtual bool i2d::ISceneController::IsFullScreenMode ( ) const
pure virtual

Check if full screen mode is enabled.

In full screen mode scene is shown on whole screen area.

Implemented in icmpstr::CSceneProviderGuiComp.

◆ SetFitMode()

virtual bool i2d::ISceneController::SetFitMode ( FittingMode fitMode)
pure virtual

Set vieport scale fitting mode.

Returns
true if fitting mode was set correctly.
See also
RestrictionFlags

Implemented in icmpstr::CSceneProviderGuiComp.

◆ SetFullScreenMode()

virtual bool i2d::ISceneController::SetFullScreenMode ( bool isFullScreen)
pure virtual

Set full screen mode on/off.

In full screen mode scene is shown on whole screen area.

Returns
true if full screen mode was set correctly.
See also
RestrictionFlags

Implemented in icmpstr::CSceneProviderGuiComp.

◆ SetScale()

virtual bool i2d::ISceneController::SetScale ( int scaleMode = SM_SET,
double value = 1.0 )
pure virtual

Set or modify scale factor.

See ScaleMode for possible modes.

Implemented in icmpstr::CSceneProviderGuiComp.


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

© Witold Gantzke and Kirill Lepskiy