open_toontown_panda3d/panda/src/display/windowProperties.I

841 lines
30 KiB
Plaintext

// Filename: windowProperties.I
// Created by: drose (13Aug02)
//
////////////////////////////////////////////////////////////////////
//
// PANDA 3D SOFTWARE
// Copyright (c) Carnegie Mellon University. All rights reserved.
//
// All use of this software is subject to the terms of the revised BSD
// license. You should have received a copy of this license along
// with this source code in a file named "LICENSE."
//
////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::Copy Constructor
// Access: Published
// Description:
////////////////////////////////////////////////////////////////////
INLINE WindowProperties::
WindowProperties(const WindowProperties &copy) {
(*this) = copy;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::Destructor
// Access: Published
// Description:
////////////////////////////////////////////////////////////////////
INLINE WindowProperties::
~WindowProperties() {
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::operator !=
// Access: Published
// Description:
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
operator != (const WindowProperties &other) const {
return !operator == (other);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::is_any_specified
// Access: Published
// Description: Returns true if any properties have been specified,
// false otherwise.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
is_any_specified() const {
return (_specified != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_origin
// Access: Published
// Description: Specifies the origin on the screen (in pixels,
// relative to the top-left corner) at which the window
// should appear. This is the origin of the top-left
// corner of the useful part of the window, not
// including decorations.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_origin(int x_origin, int y_origin) {
_x_origin = x_origin;
_y_origin = y_origin;
_specified |= S_origin;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_x_origin
// Access: Published
// Description: Returns the x coordinate of the window's top-left
// corner, not including decorations.
////////////////////////////////////////////////////////////////////
INLINE int WindowProperties::
get_x_origin() const {
nassertr(has_origin(), 0);
return _x_origin;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_y_origin
// Access: Published
// Description: Returns the y coordinate of the window's top-left
// corner, not including decorations.
////////////////////////////////////////////////////////////////////
INLINE int WindowProperties::
get_y_origin() const {
nassertr(has_origin(), 0);
return _y_origin;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_origin
// Access: Published
// Description: Returns true if the window origin has been specified,
// false otherwise.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_origin() const {
return ((_specified & S_origin) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_origin
// Access: Published
// Description: Removes the origin specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_origin() {
_specified &= ~S_origin;
_x_origin = 0;
_y_origin = 0;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_size
// Access: Published
// Description: Specifies the requested size of the window, in
// pixels. This is the size of the useful part of the
// window, not including decorations.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_size(int x_size, int y_size) {
_x_size = x_size;
_y_size = y_size;
_specified |= S_size;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_x_size
// Access: Published
// Description: Returns size in pixels in the x dimension of the
// useful part of the window, not including decorations.
// That is, this is the window's width.
////////////////////////////////////////////////////////////////////
INLINE int WindowProperties::
get_x_size() const {
nassertr(has_size(), 0);
return _x_size;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_y_size
// Access: Published
// Description: Returns size in pixels in the y dimension of the
// useful part of the window, not including decorations.
// That is, this is the window's height.
////////////////////////////////////////////////////////////////////
INLINE int WindowProperties::
get_y_size() const {
nassertr(has_size(), 0);
return _y_size;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_size
// Access: Published
// Description: Returns true if the window size has been specified,
// false otherwise.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_size() const {
return ((_specified & S_size) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_size
// Access: Published
// Description: Removes the size specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_size() {
_specified &= ~S_size;
_x_size = 0;
_y_size = 0;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_title
// Access: Published
// Description: Specifies the title that should be assigned to the
// window.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_title(const string &title) {
_title = title;
_specified |= S_title;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_title
// Access: Published
// Description: Returns the window's title.
////////////////////////////////////////////////////////////////////
INLINE const string &WindowProperties::
get_title() const {
nassertr(has_title(), _title);
return _title;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_title
// Access: Published
// Description: Returns true if the window title has been specified,
// false otherwise.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_title() const {
return ((_specified & S_title) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_title
// Access: Published
// Description: Removes the title specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_title() {
_specified &= ~S_title;
_title = string();
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_undecorated
// Access: Published
// Description: Specifies whether the window should be created with a
// visible title and border (false, the default) or not
// (true).
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_undecorated(bool undecorated) {
if (undecorated) {
_flags |= F_undecorated;
} else {
_flags &= ~F_undecorated;
}
_specified |= S_undecorated;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_undecorated
// Access: Published
// Description: Returns true if the window has no border.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
get_undecorated() const {
return (_flags & F_undecorated) != 0;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_undecorated
// Access: Published
// Description: Returns true if set_undecorated() has been specified.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_undecorated() const {
return ((_specified & S_undecorated) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_undecorated
// Access: Published
// Description: Removes the undecorated specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_undecorated() {
_specified &= ~S_undecorated;
_flags &= ~F_undecorated;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_fixed_size
// Access: Published
// Description: Specifies whether the window should be resizable by
// the user.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_fixed_size(bool fixed_size) {
if (fixed_size) {
_flags |= F_fixed_size;
} else {
_flags &= ~F_fixed_size;
}
_specified |= S_fixed_size;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_fixed_size
// Access: Published
// Description: Returns true if the window cannot be resized by the
// user, false otherwise.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
get_fixed_size() const {
return (_flags & F_fixed_size) != 0;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_fixed_size
// Access: Published
// Description: Returns true if set_fixed_size() has been specified.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_fixed_size() const {
return ((_specified & S_fixed_size) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_fixed_size
// Access: Published
// Description: Removes the fixed_size specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_fixed_size() {
_specified &= ~S_fixed_size;
_flags &= ~F_fixed_size;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_fullscreen
// Access: Published
// Description: Specifies whether the window should be opened in
// fullscreen mode (true) or normal windowed mode
// (false, the default).
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_fullscreen(bool fullscreen) {
if (fullscreen) {
_flags |= F_fullscreen;
} else {
_flags &= ~F_fullscreen;
}
_specified |= S_fullscreen;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_fullscreen
// Access: Published
// Description: Returns true if the window is in fullscreen mode.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
get_fullscreen() const {
return (_flags & F_fullscreen) != 0;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_fullscreen
// Access: Published
// Description: Returns true if set_fullscreen() has been specified.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_fullscreen() const {
return ((_specified & S_fullscreen) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_fullscreen
// Access: Published
// Description: Removes the fullscreen specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_fullscreen() {
_specified &= ~S_fullscreen;
_flags &= ~F_fullscreen;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_foreground
// Access: Published
// Description: Specifies whether the window should be opened in
// the foreground (true), or left in the background
// (false).
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_foreground(bool foreground) {
if (foreground) {
_flags |= F_foreground;
} else {
_flags &= ~F_foreground;
}
_specified |= S_foreground;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_foreground
// Access: Published
// Description: Returns true if the window is in the foreground.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
get_foreground() const {
return (_flags & F_foreground) != 0;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_foreground
// Access: Published
// Description: Returns true if set_foreground() has been specified.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_foreground() const {
return ((_specified & S_foreground) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_foreground
// Access: Published
// Description: Removes the foreground specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_foreground() {
_specified &= ~S_foreground;
_flags &= ~F_foreground;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_minimized
// Access: Published
// Description: Specifies whether the window should be created
// minimized (true), or normal (false).
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_minimized(bool minimized) {
if (minimized) {
_flags |= F_minimized;
} else {
_flags &= ~F_minimized;
}
_specified |= S_minimized;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_minimized
// Access: Published
// Description: Returns true if the window is minimized.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
get_minimized() const {
return (_flags & F_minimized) != 0;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_minimized
// Access: Published
// Description: Returns true if set_minimized() has been specified.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_minimized() const {
return ((_specified & S_minimized) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_minimized
// Access: Published
// Description: Removes the minimized specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_minimized() {
_specified &= ~S_minimized;
_flags &= ~F_minimized;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_raw_mice
// Access: Published
// Description: Specifies whether the window should read the raw
// mouse devices.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_raw_mice(bool raw_mice) {
if (raw_mice) {
_flags |= F_raw_mice;
} else {
_flags &= ~F_raw_mice;
}
_specified |= S_raw_mice;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_raw_mice
// Access: Published
// Description: Returns true if the window reads the raw mice.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
get_raw_mice() const {
return (_flags & F_raw_mice) != 0;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_raw_mice
// Access: Published
// Description: Returns true if set_raw_mice() has been specified.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_raw_mice() const {
return ((_specified & S_raw_mice) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_raw_mice
// Access: Published
// Description: Removes the raw_mice specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_raw_mice() {
_specified &= ~S_raw_mice;
_flags &= ~F_raw_mice;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_open
// Access: Published
// Description: Specifies whether the window should be open. It is
// legal to create a GraphicsWindow in the closed state,
// and later request it to open by changing this flag.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_open(bool open) {
if (open) {
_flags |= F_open;
} else {
_flags &= ~F_open;
}
_specified |= S_open;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_open
// Access: Published
// Description: Returns true if the window is open.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
get_open() const {
return (_flags & F_open) != 0;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_open
// Access: Published
// Description: Returns true if set_open() has been specified.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_open() const {
return ((_specified & S_open) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_open
// Access: Published
// Description: Removes the open specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_open() {
_specified &= ~S_open;
_flags &= ~F_open;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_cursor_hidden
// Access: Published
// Description: Specifies whether the mouse cursor should be visible.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_cursor_hidden(bool cursor_hidden) {
if (cursor_hidden) {
_flags |= F_cursor_hidden;
} else {
_flags &= ~F_cursor_hidden;
}
_specified |= S_cursor_hidden;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_cursor_hidden
// Access: Published
// Description: Returns true if the mouse cursor is invisible.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
get_cursor_hidden() const {
return (_flags & F_cursor_hidden) != 0;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_cursor_hidden
// Access: Published
// Description: Returns true if set_cursor_hidden() has been specified.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_cursor_hidden() const {
return ((_specified & S_cursor_hidden) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_cursor_hidden
// Access: Published
// Description: Removes the cursor_hidden specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_cursor_hidden() {
_specified &= ~S_cursor_hidden;
_flags &= ~F_cursor_hidden;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_icon_filename
// Access: Published
// Description: Specifies the file that contains the icon to
// associate with the window when it is minimized.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_icon_filename(const Filename &icon_filename) {
_icon_filename = icon_filename;
_specified |= S_icon_filename;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_icon_filename
// Access: Published
// Description: Returns the icon filename associated with the window.
////////////////////////////////////////////////////////////////////
INLINE const Filename &WindowProperties::
get_icon_filename() const {
return _icon_filename;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_icon_filename
// Access: Published
// Description: Returns true if set_icon_filename() has been
// specified.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_icon_filename() const {
return ((_specified & S_icon_filename) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_icon_filename
// Access: Published
// Description: Removes the icon_filename specification from the
// properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_icon_filename() {
_specified &= ~S_icon_filename;
_icon_filename = Filename();
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_cursor_filename
// Access: Published
// Description: Specifies the file that contains the icon to
// associate with the mouse cursor when it is within the
// window (and visible).
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_cursor_filename(const Filename &cursor_filename) {
_cursor_filename = cursor_filename;
_specified |= S_cursor_filename;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_cursor_filename
// Access: Published
// Description: Returns the icon filename associated with the mouse
// cursor.
////////////////////////////////////////////////////////////////////
INLINE const Filename &WindowProperties::
get_cursor_filename() const {
return _cursor_filename;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_cursor_filename
// Access: Published
// Description: Returns true if set_cursor_filename() has been
// specified.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_cursor_filename() const {
return ((_specified & S_cursor_filename) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_cursor_filename
// Access: Published
// Description: Removes the cursor_filename specification from the
// properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_cursor_filename() {
_specified &= ~S_cursor_filename;
_cursor_filename = Filename();
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_z_order
// Access: Published
// Description: Specifies the relative ordering of the window with
// respect to other windows. If the z_order is Z_top,
// the window will always be on top of other windows; if
// it is Z_bottom, it will always be below other
// windows. Most windows will want to be Z_normal,
// which allows the user to control the order.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_z_order(WindowProperties::ZOrder z_order) {
_z_order = z_order;
_specified |= S_z_order;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_z_order
// Access: Published
// Description: Returns the window's z_order.
////////////////////////////////////////////////////////////////////
INLINE WindowProperties::ZOrder WindowProperties::
get_z_order() const {
return _z_order;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_z_order
// Access: Published
// Description: Returns true if the window z_order has been specified,
// false otherwise.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_z_order() const {
return ((_specified & S_z_order) != 0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_z_order
// Access: Published
// Description: Removes the z_order specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_z_order() {
_specified &= ~S_z_order;
_z_order = Z_normal;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_mouse_mode
// Access: Published
// Description: Removes the z_order specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_mouse_mode(MouseMode mode) {
_mouse_mode=mode;
_specified |= S_mouse_mode;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_mouse_mode
// Access: Published
// Description: Removes the z_order specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE WindowProperties::MouseMode WindowProperties::
get_mouse_mode() const {
return _mouse_mode;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_moude_mode
// Access: Published
// Description: Removes the z_order specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_mouse_mode() const {
return ((_specified & S_mouse_mode)!=0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_mouse_mode
// Access: Published
// Description: Removes the z_order specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_mouse_mode() {
_specified &= ~S_mouse_mode;
_mouse_mode = M_absolute;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::set_parent_window
// Access: Published
// Description: Removes the z_order specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
set_parent_window(size_t parent) {
_parent_window=parent;
_specified |= S_parent_window;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::get_parent_window
// Access: Published
// Description: Removes the parent Window
////////////////////////////////////////////////////////////////////
INLINE size_t WindowProperties::
get_parent_window() const {
return _parent_window;
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::has_parent_window
// Access: Published
// Description: Checks the S_parent_window specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE bool WindowProperties::
has_parent_window() const {
return ((_specified & S_parent_window)!=0);
}
////////////////////////////////////////////////////////////////////
// Function: WindowProperties::clear_parent_window
// Access: Published
// Description: Removes the S_parent_window specification from the properties.
////////////////////////////////////////////////////////////////////
INLINE void WindowProperties::
clear_parent_window() {
_specified &= ~S_parent_window;
_parent_window = (size_t)NULL;
}
INLINE ostream &
operator << (ostream &out, const WindowProperties &properties) {
properties.output(out);
return out;
}