GraphicsWindow

class GraphicsWindow

Bases: GraphicsOutput

A window, fullscreen or on a desktop, into which a graphics device sends its output for interactive display.

Inheritance diagram

void clear_rejected_properties(void): Empties the set of failed properties that will be returned by get_rejected_properties().

virtual void close_ime(void): Forces the ime window to close if any

void disable_pointer_events(int device): Turn off the generation of pointer events.

void enable_pointer_events(int device): Turn on the generation of pointer events.

static TypeHandle get_class_type(void)

std::string get_close_request_event(void) const: Returns the name of the event set via set_close_request_event(). If this string is nonempty, then when the user requests to close window, this event will be generated instead. See set_close_request_event().

InputDevice *get_input_device(int i) const: Returns the nth input device associated with the window. Typically, a window will have exactly one input device: the keyboard/mouse pair.

std::string get_input_device_name(int device) const: Returns the name of the nth input device.

virtual ButtonMap *get_keyboard_map(void) const: Returns a ButtonMap containing the association between raw buttons and virtual buttons.

int get_num_input_devices(void) const

Mouse and keyboard routines

Returns the number of separate input devices associated with the window. Typically, a window will have exactly one input device: the keyboard/mouse pair. However, some windows may have no input devices, and others may add additional devices, for instance for a joystick.

virtual MouseData get_pointer(int device) const: Returns the MouseData associated with the nth input device’s pointer. Using this to access raw mice (with an index other than 0) is deprecated, see the InputDeviceManager interface instead.

WindowProperties const get_properties(void) const: Returns the current properties of the window.

WindowProperties get_rejected_properties(void) const: Returns the set of properties that have recently been requested, but could not be applied to the window for some reason. This set of properties will remain unchanged until they are changed by a new failed request, or clear_rejected_properties() is called.

WindowProperties const get_requested_properties(void) const: Returns the properties of the window that are currently requested. These properties will be applied to the window (if valid) at the next execution of process_events().

bool get_unexposed_draw(void) const: See set_unexposed_draw().

std::string get_window_event(void) const: Returns the name of the event that is generated when this window is modified externally, e.g. to be resized or closed by the user. See set_window_event().

WindowHandle *get_window_handle(void) const: Returns the WindowHandle corresponding to this window on the desktop. This is mainly useful for communicating with external libraries. Use window_handle->get_os_handle()->get_handle(), or window_handle->get_string_handle(), to get the actual OS-specific window handle object, whatever type that might be.

bool has_keyboard(int device) const: Returns true if the nth input device has a keyboard, false otherwise.

bool has_pointer(int device) const: Returns true if the nth input device has a screen-space pointer (for instance, a mouse), false otherwise.

bool is_closed(void) const: Returns true if the window has not yet been opened, or has been fully closed, false if it is open. The window is not opened immediately after GraphicsEngine::make_output() is called; nor is it closed immediately after GraphicsEngine::remove_window() is called. Either operation may take a frame or two.

bool is_fullscreen(void) const: Returns true if the window has been opened as a fullscreen window, false otherwise.

virtual bool move_pointer(int device, int x, int y)

Forces the pointer to the indicated position within the window, if possible.

Returns true if successful, false on failure. This may fail if the mouse is not currently within the window, or if the API doesn’t support this operation.

void request_properties(WindowProperties const &requested_properties)

Requests a property change on the window. For example, use this method to request a window change size or minimize or something.

The change is not made immediately; rather, the request is saved and will be applied the next time the window task is run (probably at the next frame).

void set_close_request_event(std::string const &close_request_event)

Sets the event that is triggered when the user requests to close the window, e.g. via alt-F4, or clicking on the close box.

The default for each window is for this event to be the empty string, which means the window-close request is handled immediately by Panda (and the window will be closed without the app getting a chance to intervene). If you set this to a nonempty string, then the window is not closed, but instead the event is thrown. It is then up to the app to respond appropriately, for instance by presenting an “are you sure?” dialog box, and eventually calling close_window() when the user is sure.

It is considered poor form to set this string and then not handle the event. This can frustrate the user by making it difficult for him to cleanly shut down the application (and may force the user to hard-kill the app, or reboot the machine).

void set_unexposed_draw(bool unexposed_draw): If this flag is false, the window is redrawn only after it has received a recent “unexpose” or “draw” event from the underlying windowing system. If this flag is true, the window is redrawn every frame regardless. Setting this false may prevent the window from redrawing unnecessarily when it is hidden, and may play nicer with other windows on the desktop, but may adversely affect frame rate even when the window is fully visible; setting it true will ensure that the window contents are always current.

void set_window_event(std::string const &window_event)

Changes the name of the event that is generated when this window is modified externally, e.g. to be resized or closed by the user.

By default, all windows have the same window event unless they are explicitly changed. When the event is generated, it includes one parameter: the window itself.