panda3d.core.WindowProperties

class WindowProperties

A container for the various kinds of properties we might ask to have on a graphics window before we open it. This also serves to hold the current properties for a window after it has been opened.

Inheritance diagram

Inheritance diagram of WindowProperties

enum MouseMode
enumerator M_absolute = 0
enumerator M_relative = 1
enumerator M_confined = 2
enum ZOrder
enumerator Z_bottom = 0
enumerator Z_normal = 1
enumerator Z_top = 2
__init__(args: object, kwds: object) → None
addProperties(other: WindowProperties) → None

Sets any properties that are explicitly specified in other on this object. Leaves other properties unchanged.

assign(copy: WindowProperties) → WindowProperties
Return type

WindowProperties

clear() → None

Unsets all properties that have been specified so far, and resets the WindowProperties structure to its initial empty state.

clearCursorFilename() → None

Removes the cursor_filename specification from the properties.

clearCursorHidden() → None

Removes the cursor_hidden specification from the properties.

static clearDefault() → None

Returns the “default” WindowProperties to whatever is specified in the user’s config file.

clearFixedSize() → None

Removes the fixed_size specification from the properties.

clearForeground() → None

Removes the foreground specification from the properties.

clearFullscreen() → None

Removes the fullscreen specification from the properties.

clearIconFilename() → None

Removes the icon_filename specification from the properties.

clearMinimized() → None

Removes the minimized specification from the properties.

clearMouseMode() → None

Removes the mouse_mode specification from the properties.

clearOpen() → None

Removes the open specification from the properties.

clearOrigin() → None

Removes the origin specification from the properties.

clearParentWindow() → None

Removes the S_parent_window specification from the properties.

clearRawMice() → None

Removes the raw_mice specification from the properties.

clearSize() → None

Removes the size specification from the properties.

clearTitle() → None

Removes the title specification from the properties.

clearUndecorated() → None

Removes the undecorated specification from the properties.

clearZOrder() → None

Removes the z_order specification from the properties.

property config_properties

Returns a WindowProperties structure with all of the default values filled in according to the user’s config file.

Return type

WindowProperties

property cursor_filename
Getter

Returns the icon filename associated with the mouse cursor.

Setter

Specifies the file that contains the icon to associate with the mouse cursor when it is within the window (and visible).

Return type

Filename

property cursor_hidden
Getter

Returns true if the mouse cursor is invisible.

Setter

Specifies whether the mouse cursor should be visible.

Return type

bool

property default
Getter

Returns the “default” WindowProperties. If setDefault() has been called, this returns that WindowProperties structure; otherwise, this returns getConfigProperties().

Setter

Replaces the “default” WindowProperties with the specified structure. The specified WindowProperties will be returned by future calls to getDefault(), until clearDefault() is called.

Note that this completely replaces the default properties; it is not additive.

Return type

WindowProperties

property fixed_size
Getter

Returns true if the window cannot be resized by the user, false otherwise.

Setter

Specifies whether the window should be resizable by the user.

Return type

bool

property foreground
Getter

Returns true if the window is in the foreground.

Setter

Specifies whether the window should be opened in the foreground (true), or left in the background (false).

Return type

bool

property fullscreen
Getter

Returns true if the window is in fullscreen mode.

Setter

Specifies whether the window should be opened in fullscreen mode (true) or normal windowed mode (false, the default).

Return type

bool

static getConfigProperties() → WindowProperties

Returns a WindowProperties structure with all of the default values filled in according to the user’s config file.

Return type

WindowProperties

getCursorFilename() → Filename

Returns the icon filename associated with the mouse cursor.

Return type

Filename

getCursorHidden() → bool

Returns true if the mouse cursor is invisible.

static getDefault() → WindowProperties

Returns the “default” WindowProperties. If setDefault() has been called, this returns that WindowProperties structure; otherwise, this returns getConfigProperties().

Return type

WindowProperties

getFixedSize() → bool

Returns true if the window cannot be resized by the user, false otherwise.

getForeground() → bool

Returns true if the window is in the foreground.

getFullscreen() → bool

Returns true if the window is in fullscreen mode.

getIconFilename() → Filename

Returns the icon filename associated with the window.

Return type

Filename

getMinimized() → bool

Returns true if the window is minimized.

getMouseMode() → MouseMode

See setMouseMode().

Return type

MouseMode

getOpen() → bool

Returns true if the window is open.

getOrigin() → LPoint2i

Returns the coordinates of the window’s top-left corner, not including decorations.

Return type

LPoint2i

getParentWindow() → WindowHandle

Returns the parent window specification, or NULL if there is no parent window specified.

Return type

WindowHandle

getRawMice() → bool

Returns true if the window reads the raw mice.

getSize() → LVector2i

Returns size in pixels of the useful part of the window, not including decorations.

Return type

LVector2i

getTitle() → str

Returns the window’s title.

getUndecorated() → bool

Returns true if the window has no border.

getXOrigin() → int

Returns the x coordinate of the window’s top-left corner, not including decorations.

getXSize() → int

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.

getYOrigin() → int

Returns the y coordinate of the window’s top-left corner, not including decorations.

getYSize() → int

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.

getZOrder() → ZOrder

Returns the window’s z_order.

Return type

ZOrder

hasCursorFilename() → bool

Returns true if setCursorFilename() has been specified.

hasCursorHidden() → bool

Returns true if setCursorHidden() has been specified.

hasFixedSize() → bool

Returns true if setFixedSize() has been specified.

hasForeground() → bool

Returns true if setForeground() has been specified.

hasFullscreen() → bool

Returns true if setFullscreen() has been specified.

hasIconFilename() → bool

Returns true if setIconFilename() has been specified.

hasMinimized() → bool

Returns true if setMinimized() has been specified.

hasMouseMode() → bool
hasOpen() → bool

Returns true if setOpen() has been specified.

hasOrigin() → bool

Returns true if the window origin has been specified, false otherwise.

hasParentWindow() → bool

Checks the S_parent_window specification from the properties.

hasRawMice() → bool

Returns true if setRawMice() has been specified.

hasSize() → bool

Returns true if the window size has been specified, false otherwise.

hasTitle() → bool

Returns true if the window title has been specified, false otherwise.

hasUndecorated() → bool

Returns true if setUndecorated() has been specified.

hasZOrder() → bool

Returns true if the window z_order has been specified, false otherwise.

property icon_filename
Getter

Returns the icon filename associated with the window.

Setter

Specifies the file that contains the icon to associate with the window when it is minimized.

Return type

Filename

isAnySpecified() → bool

Returns true if any properties have been specified, false otherwise.

property minimized
Getter

Returns true if the window is minimized.

Setter

Specifies whether the window should be created minimized (true), or normal (false).

Return type

bool

property mouse_mode
Getter

See setMouseMode().

Setter

Specifies the mode in which the window is to operate its mouse pointer.

M_absolute: the normal mode in which a mouse pointer operates, where the mouse can move outside the window and the mouse coordinates are relative to its position in the window.

M_relative (OSX or Unix/X11 only): a mode where only relative movements are reported; particularly useful for FPS-style mouse movements where you have hidden the mouse pointer and are are more interested in how fast the mouse is moving, rather than precisely where the pointer is hovering.

This has no effect on Windows. On Unix/X11, this requires the Xxf86dga extension to be available.

M_confined: this mode reports absolute mouse positions, but confines the mouse pointer to the window boundary. It can portably replace M_relative for an FPS, but you need to periodically move the pointer to the center of the window and track movement deltas.

Return type

MouseMode

property open
Getter

Returns true if the window is open.

Setter

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.

Return type

bool

property origin
Getter

Returns the coordinates of the window’s top-left corner, not including decorations.

Setter

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.

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.

Return type

LPoint2i

output(out: ostream) → None

Sets any properties that are explicitly specified in other on this object. Leaves other properties unchanged.

property parent_window
Getter

Returns the parent window specification, or NULL if there is no parent window specified.

Setter

Specifies the window that this window should be attached to. If this is NULL or unspecified, the window will be created as a toplevel window on the desktop; if this is non-NULL, the window will be bound as a child window to the indicated parent window.

You should use GraphicsPipe::make_window_handle() to create an instance of a WindowHandle object given an appropriate OS-specific window handle representation. Each OS-specific GraphicsPipe class defines a make_window_handle() method that returns an appropriate WindowHandle object to wrap the particular OS-specific representation.

Specifies the window that this window should be attached to.

This is a deprecated variant on this method, and exists only for backward compatibility. Future code should use the version of setParentWindow() below that receives a WindowHandle object; that interface is much more robust.

In this deprecated variant, the actual value for “parent” is platform- specific. On Windows, it is the HWND of the parent window, cast to an unsigned integer. On X11, it is the Window pointer of the parent window, similarly cast. On OSX, this is the NSWindow pointer, which doesn’t appear to work at all.

Return type

WindowHandle

setCursorFilename(cursor_filename: Filename) → None

Specifies the file that contains the icon to associate with the mouse cursor when it is within the window (and visible).

setCursorHidden(cursor_hidden: bool) → None

Specifies whether the mouse cursor should be visible.

static setDefault(default_properties: WindowProperties) → None

Replaces the “default” WindowProperties with the specified structure. The specified WindowProperties will be returned by future calls to getDefault(), until clearDefault() is called.

Note that this completely replaces the default properties; it is not additive.

setFixedSize(fixed_size: bool) → None

Specifies whether the window should be resizable by the user.

setForeground(foreground: bool) → None

Specifies whether the window should be opened in the foreground (true), or left in the background (false).

setFullscreen(fullscreen: bool) → None

Specifies whether the window should be opened in fullscreen mode (true) or normal windowed mode (false, the default).

setIconFilename(icon_filename: Filename) → None

Specifies the file that contains the icon to associate with the window when it is minimized.

setMinimized(minimized: bool) → None

Specifies whether the window should be created minimized (true), or normal (false).

setMouseMode(mode: MouseMode) → None

Specifies the mode in which the window is to operate its mouse pointer.

M_absolute: the normal mode in which a mouse pointer operates, where the mouse can move outside the window and the mouse coordinates are relative to its position in the window.

M_relative (OSX or Unix/X11 only): a mode where only relative movements are reported; particularly useful for FPS-style mouse movements where you have hidden the mouse pointer and are are more interested in how fast the mouse is moving, rather than precisely where the pointer is hovering.

This has no effect on Windows. On Unix/X11, this requires the Xxf86dga extension to be available.

M_confined: this mode reports absolute mouse positions, but confines the mouse pointer to the window boundary. It can portably replace M_relative for an FPS, but you need to periodically move the pointer to the center of the window and track movement deltas.

setOpen(open: bool) → None

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.

setOrigin(origin: LPoint2i) → None

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.

setOrigin(x_origin: int, y_origin: int) → None

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.

setParentWindow(parent_window: WindowHandle) → None

Specifies the window that this window should be attached to. If this is NULL or unspecified, the window will be created as a toplevel window on the desktop; if this is non-NULL, the window will be bound as a child window to the indicated parent window.

You should use GraphicsPipe::make_window_handle() to create an instance of a WindowHandle object given an appropriate OS-specific window handle representation. Each OS-specific GraphicsPipe class defines a make_window_handle() method that returns an appropriate WindowHandle object to wrap the particular OS-specific representation.

setParentWindow(parent: size_t) → None

Specifies the window that this window should be attached to.

This is a deprecated variant on this method, and exists only for backward compatibility. Future code should use the version of setParentWindow() below that receives a WindowHandle object; that interface is much more robust.

In this deprecated variant, the actual value for “parent” is platform- specific. On Windows, it is the HWND of the parent window, cast to an unsigned integer. On X11, it is the Window pointer of the parent window, similarly cast. On OSX, this is the NSWindow pointer, which doesn’t appear to work at all.

setRawMice(raw_mice: bool) → None

Specifies whether the window should read the raw mouse devices.

setSize(size: LVector2i) → None

Specifies the requested size of the window, in pixels. This is the size of the useful part of the window, not including decorations.

setSize(x_size: int, y_size: int) → None

Specifies the requested size of the window, in pixels. This is the size of the useful part of the window, not including decorations.

setTitle(title: str) → None

Specifies the title that should be assigned to the window.

setUndecorated(undecorated: bool) → None

Specifies whether the window should be created with a visible title and border (false, the default) or not (true).

setZOrder(z_order: ZOrder) → None

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.

static size(size: LVecBase2i) → WindowProperties

Returns a WindowProperties structure with only the size specified. The size is the only property that matters to buffers.

Deprecated: in the Python API, use :class:`~WindowProperties`(size=(x, y)) instead.

Return type

WindowProperties

static size(x_size: int, y_size: int) → WindowProperties
Return type

WindowProperties

property size
Getter

Returns size in pixels of the useful part of the window, not including decorations.

Setter

Specifies the requested size of the window, in pixels. This is the size of the useful part of the window, not including decorations.

Specifies the requested size of the window, in pixels. This is the size of the useful part of the window, not including decorations.

Return type

LVector2i

property title
Getter

Returns the window’s title.

Setter

Specifies the title that should be assigned to the window.

Return type

string

property undecorated
Getter

Returns true if the window has no border.

Setter

Specifies whether the window should be created with a visible title and border (false, the default) or not (true).

Return type

bool

property z_order
Getter

Returns the window’s z_order.

Setter

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.

Return type

ZOrder