Open CASCADE Technology  7.7.0.dev
Public Member Functions | Protected Member Functions | Protected Attributes

Aspect_Window Class Referenceabstract

Defines a window. More...

#include <Aspect_Window.hxx>

Inheritance diagram for Aspect_Window:
Inheritance graph
[legend]

Public Member Functions

Standard_Boolean IsVirtual () const
 Returns True if the window <me> is virtual. More...
 
void SetVirtual (const Standard_Boolean theVirtual)
 Setup the virtual state. More...
 
Graphic3d_Vec2i TopLeft () const
 Returns window top-left corner. More...
 
Graphic3d_Vec2i Dimensions () const
 Returns window dimensions. More...
 
const Handle< Aspect_DisplayConnection > & DisplayConnection () const
 Returns connection to Display or NULL. More...
 
Aspect_Background Background () const
 Returns the window background. More...
 
Aspect_FillMethod BackgroundFillMethod () const
 Returns the current image background fill mode. More...
 
Aspect_GradientBackground GradientBackground () const
 Returns the window gradient background. More...
 
void SetBackground (const Aspect_Background &theBack)
 Modifies the window background. More...
 
void SetBackground (const Quantity_Color &theColor)
 Modifies the window background. More...
 
void SetBackground (const Aspect_GradientBackground &theBackground)
 Modifies the window gradient background. More...
 
void SetBackground (const Quantity_Color &theFirstColor, const Quantity_Color &theSecondColor, const Aspect_GradientFillMethod theFillMethod)
 Modifies the window gradient background. More...
 
virtual Standard_Boolean IsMapped () const =0
 Returns True if the window <me> is opened and False if the window is closed. More...
 
virtual void Map () const =0
 Opens the window <me>. More...
 
virtual void Unmap () const =0
 Closes the window <me>. More...
 
virtual Aspect_TypeOfResize DoResize ()=0
 Apply the resizing to the window <me>. More...
 
virtual Standard_Boolean DoMapping () const =0
 Apply the mapping change to the window <me>. and returns TRUE if the window is mapped at screen. More...
 
virtual Standard_Real Ratio () const =0
 Returns The Window RATIO equal to the physical WIDTH/HEIGHT dimensions. More...
 
virtual void Position (Standard_Integer &X1, Standard_Integer &Y1, Standard_Integer &X2, Standard_Integer &Y2) const =0
 Returns The Window POSITION in PIXEL. More...
 
virtual void Size (Standard_Integer &Width, Standard_Integer &Height) const =0
 Returns The Window SIZE in PIXEL. More...
 
virtual Aspect_Drawable NativeHandle () const =0
 Returns native Window handle (HWND on Windows, Window with Xlib, and so on) More...
 
virtual Aspect_Drawable NativeParentHandle () const =0
 Returns parent of native Window handle (HWND on Windows, Window with Xlib, and so on) More...
 
virtual Aspect_FBConfig NativeFBConfig () const =0
 Returns native Window FB config (GLXFBConfig on Xlib) More...
 
virtual void SetTitle (const TCollection_AsciiString &theTitle)
 Sets window title. More...
 
virtual void InvalidateContent (const Handle< Aspect_DisplayConnection > &theDisp)
 Invalidate entire window content. More...
 
virtual Standard_Real DevicePixelRatio () const
 Return device pixel ratio (logical to backing store scale factor). More...
 
virtual Graphic3d_Vec2d ConvertPointToBacking (const Graphic3d_Vec2d &thePnt) const
 Convert point from logical units into backing store units. More...
 
virtual Graphic3d_Vec2d ConvertPointFromBacking (const Graphic3d_Vec2d &thePnt) const
 Convert point from backing store units to logical units. More...
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Member Functions

 Aspect_Window ()
 Initializes the data of a Window. More...
 

Protected Attributes

Handle< Aspect_DisplayConnectionmyDisplay
 Display connection. More...
 
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. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

Defines a window.

Constructor & Destructor Documentation

◆ Aspect_Window()

Aspect_Window::Aspect_Window ( )
protected

Initializes the data of a Window.

Member Function Documentation

◆ Background()

Aspect_Background Aspect_Window::Background ( ) const

Returns the window background.

◆ BackgroundFillMethod()

Aspect_FillMethod Aspect_Window::BackgroundFillMethod ( ) const

Returns the current image background fill mode.

◆ ConvertPointFromBacking()

virtual Graphic3d_Vec2d Aspect_Window::ConvertPointFromBacking ( const Graphic3d_Vec2d thePnt) const
inlinevirtual

Convert point from backing store units to logical units.

◆ ConvertPointToBacking()

virtual Graphic3d_Vec2d Aspect_Window::ConvertPointToBacking ( const Graphic3d_Vec2d thePnt) const
inlinevirtual

Convert point from logical units into backing store units.

◆ DevicePixelRatio()

virtual Standard_Real Aspect_Window::DevicePixelRatio ( ) const
inlinevirtual

Return device pixel ratio (logical to backing store scale factor).

Reimplemented in Wasm_Window.

◆ Dimensions()

Graphic3d_Vec2i Aspect_Window::Dimensions ( ) const
inline

Returns window dimensions.

◆ DisplayConnection()

const Handle< Aspect_DisplayConnection >& Aspect_Window::DisplayConnection ( ) const
inline

Returns connection to Display or NULL.

◆ DoMapping()

virtual Standard_Boolean Aspect_Window::DoMapping ( ) const
pure virtual

Apply the mapping change to the window <me>. and returns TRUE if the window is mapped at screen.

Implemented in Xw_Window, Wasm_Window, Cocoa_Window, and Aspect_NeutralWindow.

◆ DoResize()

virtual Aspect_TypeOfResize Aspect_Window::DoResize ( )
pure virtual

Apply the resizing to the window <me>.

Implemented in Xw_Window, Wasm_Window, Cocoa_Window, and Aspect_NeutralWindow.

◆ DumpJson()

void Aspect_Window::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const

Dumps the content of me into the stream.

◆ GradientBackground()

Aspect_GradientBackground Aspect_Window::GradientBackground ( ) const

Returns the window gradient background.

◆ InvalidateContent()

virtual void Aspect_Window::InvalidateContent ( const Handle< Aspect_DisplayConnection > &  theDisp)
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, Xw_Window, and Wasm_Window.

◆ IsMapped()

virtual Standard_Boolean Aspect_Window::IsMapped ( ) const
pure virtual

Returns True if the window <me> is opened and False if the window is closed.

Implemented in Xw_Window, Wasm_Window, Cocoa_Window, and Aspect_NeutralWindow.

◆ IsVirtual()

Standard_Boolean Aspect_Window::IsVirtual ( ) const

Returns True if the window <me> is virtual.

◆ Map()

virtual void Aspect_Window::Map ( ) const
pure virtual

Opens the window <me>.

Implemented in Xw_Window, Wasm_Window, Cocoa_Window, and Aspect_NeutralWindow.

◆ NativeFBConfig()

virtual Aspect_FBConfig Aspect_Window::NativeFBConfig ( ) const
pure virtual

Returns native Window FB config (GLXFBConfig on Xlib)

Implemented in Xw_Window, Wasm_Window, Cocoa_Window, and Aspect_NeutralWindow.

◆ NativeHandle()

virtual Aspect_Drawable Aspect_Window::NativeHandle ( ) const
pure virtual

Returns native Window handle (HWND on Windows, Window with Xlib, and so on)

Implemented in Xw_Window, Wasm_Window, Cocoa_Window, and Aspect_NeutralWindow.

◆ NativeParentHandle()

virtual Aspect_Drawable Aspect_Window::NativeParentHandle ( ) const
pure virtual

Returns parent of native Window handle (HWND on Windows, Window with Xlib, and so on)

Implemented in Xw_Window, Wasm_Window, Cocoa_Window, and Aspect_NeutralWindow.

◆ Position()

virtual void Aspect_Window::Position ( Standard_Integer X1,
Standard_Integer Y1,
Standard_Integer X2,
Standard_Integer Y2 
) const
pure virtual

Returns The Window POSITION in PIXEL.

Implemented in Xw_Window, Cocoa_Window, Wasm_Window, and Aspect_NeutralWindow.

◆ Ratio()

virtual Standard_Real Aspect_Window::Ratio ( ) const
pure virtual

Returns The Window RATIO equal to the physical WIDTH/HEIGHT dimensions.

Implemented in Xw_Window, Wasm_Window, Cocoa_Window, and Aspect_NeutralWindow.

◆ SetBackground() [1/4]

void Aspect_Window::SetBackground ( const Aspect_Background theBack)

Modifies the window background.

◆ SetBackground() [2/4]

void Aspect_Window::SetBackground ( const Aspect_GradientBackground theBackground)

Modifies the window gradient background.

◆ SetBackground() [3/4]

void Aspect_Window::SetBackground ( const Quantity_Color theColor)

Modifies the window background.

◆ SetBackground() [4/4]

void Aspect_Window::SetBackground ( const Quantity_Color theFirstColor,
const Quantity_Color theSecondColor,
const Aspect_GradientFillMethod  theFillMethod 
)

Modifies the window gradient background.

◆ SetTitle()

virtual void Aspect_Window::SetTitle ( const TCollection_AsciiString theTitle)
inlinevirtual

Sets window title.

Reimplemented in Xw_Window, and Cocoa_Window.

◆ SetVirtual()

void Aspect_Window::SetVirtual ( const Standard_Boolean  theVirtual)

Setup the virtual state.

◆ Size()

virtual void Aspect_Window::Size ( Standard_Integer Width,
Standard_Integer Height 
) const
pure virtual

Returns The Window SIZE in PIXEL.

Implemented in Xw_Window, Wasm_Window, Cocoa_Window, and Aspect_NeutralWindow.

◆ TopLeft()

Graphic3d_Vec2i Aspect_Window::TopLeft ( ) const
inline

Returns window top-left corner.

◆ Unmap()

virtual void Aspect_Window::Unmap ( ) const
pure virtual

Closes the window <me>.

Implemented in Xw_Window, Wasm_Window, Cocoa_Window, and Aspect_NeutralWindow.

Field Documentation

◆ MyBackground

Aspect_Background Aspect_Window::MyBackground
protected

◆ MyBackgroundFillMethod

Aspect_FillMethod Aspect_Window::MyBackgroundFillMethod
protected

◆ myDisplay

Handle< Aspect_DisplayConnection > Aspect_Window::myDisplay
protected

Display connection.

◆ MyGradientBackground

Aspect_GradientBackground Aspect_Window::MyGradientBackground
protected

◆ MyIsVirtual

Standard_Boolean Aspect_Window::MyIsVirtual
protected

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