Open CASCADE Technology 7.8.2.dev
|
Defines a window. More...
#include <Aspect_Window.hxx>
Public Member Functions | |
Standard_Boolean | IsVirtual () const |
Returns True if the window <me> is virtual. | |
void | SetVirtual (const Standard_Boolean theVirtual) |
Setup the virtual state. | |
Graphic3d_Vec2i | TopLeft () const |
Returns window top-left corner. | |
Graphic3d_Vec2i | Dimensions () const |
Returns window dimensions. | |
const Handle< Aspect_DisplayConnection > & | DisplayConnection () const |
Returns connection to Display or NULL. | |
Aspect_Background | Background () const |
Returns the window background. | |
Aspect_FillMethod | BackgroundFillMethod () const |
Returns the current image background fill mode. | |
Aspect_GradientBackground | GradientBackground () const |
Returns the window gradient background. | |
void | SetBackground (const Aspect_Background &theBack) |
Modifies the window background. | |
void | SetBackground (const Quantity_Color &theColor) |
Modifies the window background. | |
void | SetBackground (const Aspect_GradientBackground &theBackground) |
Modifies the window gradient background. | |
void | SetBackground (const Quantity_Color &theFirstColor, const Quantity_Color &theSecondColor, const Aspect_GradientFillMethod theFillMethod) |
Modifies the window gradient background. | |
virtual Standard_Boolean | IsMapped () const =0 |
Returns True if the window <me> is opened and False if the window is closed. | |
virtual void | Map () const =0 |
Opens the window <me>. | |
virtual void | Unmap () const =0 |
Closes the window <me>. | |
virtual Aspect_TypeOfResize | DoResize ()=0 |
Apply the resizing to the window <me>. | |
virtual Standard_Boolean | DoMapping () const =0 |
Apply the mapping change to the window <me>. and returns TRUE if the window is mapped at screen. | |
virtual Standard_Real | Ratio () const =0 |
Returns The Window RATIO equal to the physical WIDTH/HEIGHT dimensions. | |
virtual void | Position (Standard_Integer &X1, Standard_Integer &Y1, Standard_Integer &X2, Standard_Integer &Y2) const =0 |
Returns The Window POSITION in PIXEL. | |
virtual void | Size (Standard_Integer &Width, Standard_Integer &Height) const =0 |
Returns The Window SIZE in PIXEL. | |
virtual Aspect_Drawable | NativeHandle () const =0 |
Returns native Window handle (HWND on Windows, Window with Xlib, and so on) | |
virtual Aspect_Drawable | NativeParentHandle () const =0 |
Returns parent of native Window handle (HWND on Windows, Window with Xlib, and so on) | |
virtual Aspect_FBConfig | NativeFBConfig () const =0 |
Returns native Window FB config (GLXFBConfig on Xlib) | |
virtual void | SetTitle (const TCollection_AsciiString &theTitle) |
Sets window title. | |
virtual void | InvalidateContent (const Handle< Aspect_DisplayConnection > &theDisp) |
Invalidate entire window content. | |
virtual Standard_Real | DevicePixelRatio () const |
Return device pixel ratio (logical to backing store scale factor). | |
virtual Graphic3d_Vec2d | ConvertPointToBacking (const Graphic3d_Vec2d &thePnt) const |
Convert point from logical units into backing store units. | |
virtual Graphic3d_Vec2d | ConvertPointFromBacking (const Graphic3d_Vec2d &thePnt) const |
Convert point from backing store units to logical units. | |
void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const |
Dumps the content of me into the stream. | |
Public Member Functions inherited from Standard_Transient | |
Standard_Transient () | |
Empty constructor. | |
Standard_Transient (const Standard_Transient &) | |
Copy constructor – does nothing. | |
Standard_Transient & | operator= (const Standard_Transient &) |
Assignment operator, needed to avoid copying reference counter. | |
virtual | ~Standard_Transient () |
Destructor must be virtual. | |
virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
Returns a type descriptor about this object. | |
Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
Returns a true value if this is an instance of Type. | |
Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
Returns a true value if this is an instance of TypeName. | |
Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
Standard_Transient * | This () const |
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. | |
Standard_Integer | GetRefCount () const noexcept |
Get the reference counter of this object. | |
void | IncrementRefCounter () noexcept |
Increments the reference counter of this object. | |
Standard_Integer | DecrementRefCounter () noexcept |
Decrements the reference counter of this object; returns the decremented value. | |
virtual void | Delete () const |
Memory deallocator for transient classes. | |
Protected Member Functions | |
Aspect_Window () | |
Initializes the data of a Window. | |
Protected Attributes | |
Handle< Aspect_DisplayConnection > | myDisplay |
Display connection. | |
Aspect_Background | MyBackground |
Aspect_GradientBackground | MyGradientBackground |
Aspect_FillMethod | MyBackgroundFillMethod |
Standard_Boolean | MyIsVirtual |
Additional Inherited Members | |
Public Types inherited from Standard_Transient | |
typedef void | base_type |
Returns a type descriptor about this object. | |
Static Public Member Functions inherited from Standard_Transient | |
static constexpr const char * | get_type_name () |
Returns a type descriptor about this object. | |
static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
Returns type descriptor of Standard_Transient class. | |
Defines a window.
|
protected |
Initializes the data of a Window.
Aspect_Background Aspect_Window::Background | ( | ) | const |
Returns the window background.
Aspect_FillMethod Aspect_Window::BackgroundFillMethod | ( | ) | const |
Returns the current image background fill mode.
|
inlinevirtual |
Convert point from backing store units to logical units.
|
inlinevirtual |
Convert point from logical units into backing store units.
|
inlinevirtual |
Return device pixel ratio (logical to backing store scale factor).
Reimplemented in Wasm_Window.
|
inline |
Returns window dimensions.
|
inline |
Returns connection to Display or NULL.
|
pure virtual |
Apply the mapping change to the window <me>. and returns TRUE if the window is mapped at screen.
Implemented in Aspect_NeutralWindow, Cocoa_Window, Wasm_Window, and Xw_Window.
|
pure virtual |
Apply the resizing to the window <me>.
Implemented in Aspect_NeutralWindow, Cocoa_Window, Wasm_Window, and Xw_Window.
void Aspect_Window::DumpJson | ( | Standard_OStream & | theOStream, |
Standard_Integer | theDepth = -1 ) const |
Dumps the content of me into the stream.
Aspect_GradientBackground Aspect_Window::GradientBackground | ( | ) | const |
Returns the window gradient background.
|
inlinevirtual |
Invalidate entire window content.
Implementation is expected to allow calling this method from non-GUI thread, e.g. by queuing exposure event into window message queue or in other thread-safe manner.
Optional display argument should be passed when called from non-GUI thread on platforms implementing thread-unsafe connections to display. NULL can be passed instead otherwise.
Reimplemented in Cocoa_Window, Wasm_Window, and Xw_Window.
|
pure virtual |
Returns True if the window <me> is opened and False if the window is closed.
Implemented in Aspect_NeutralWindow, Cocoa_Window, Wasm_Window, and Xw_Window.
Standard_Boolean Aspect_Window::IsVirtual | ( | ) | const |
Returns True if the window <me> is virtual.
|
pure virtual |
Opens the window <me>.
Implemented in Aspect_NeutralWindow, Cocoa_Window, Wasm_Window, and Xw_Window.
|
pure virtual |
Returns native Window FB config (GLXFBConfig on Xlib)
Implemented in Aspect_NeutralWindow, Cocoa_Window, Wasm_Window, and Xw_Window.
|
pure virtual |
Returns native Window handle (HWND on Windows, Window with Xlib, and so on)
Implemented in Aspect_NeutralWindow, Cocoa_Window, Wasm_Window, and Xw_Window.
|
pure virtual |
Returns parent of native Window handle (HWND on Windows, Window with Xlib, and so on)
Implemented in Aspect_NeutralWindow, Cocoa_Window, Wasm_Window, and Xw_Window.
|
pure virtual |
Returns The Window POSITION in PIXEL.
Implemented in Aspect_NeutralWindow, Cocoa_Window, Wasm_Window, and Xw_Window.
|
pure virtual |
Returns The Window RATIO equal to the physical WIDTH/HEIGHT dimensions.
Implemented in Aspect_NeutralWindow, Cocoa_Window, Wasm_Window, and Xw_Window.
void Aspect_Window::SetBackground | ( | const Aspect_Background & | theBack | ) |
Modifies the window background.
void Aspect_Window::SetBackground | ( | const Aspect_GradientBackground & | theBackground | ) |
Modifies the window gradient background.
void Aspect_Window::SetBackground | ( | const Quantity_Color & | theColor | ) |
Modifies the window background.
void Aspect_Window::SetBackground | ( | const Quantity_Color & | theFirstColor, |
const Quantity_Color & | theSecondColor, | ||
const Aspect_GradientFillMethod | theFillMethod ) |
Modifies the window gradient background.
|
inlinevirtual |
Sets window title.
Reimplemented in Cocoa_Window, and Xw_Window.
void Aspect_Window::SetVirtual | ( | const Standard_Boolean | theVirtual | ) |
Setup the virtual state.
|
pure virtual |
Returns The Window SIZE in PIXEL.
Implemented in Aspect_NeutralWindow, Cocoa_Window, Wasm_Window, and Xw_Window.
|
inline |
Returns window top-left corner.
|
pure virtual |
Closes the window <me>.
Implemented in Aspect_NeutralWindow, Cocoa_Window, Wasm_Window, and Xw_Window.
|
protected |
|
protected |
|
protected |
Display connection.
|
protected |
|
protected |