Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends

WindowFramework Class Reference

This encapsulates the data that is normally associated with a single window, or with a single display region within a window. More...

#include "windowFramework.h"

Inheritance diagram for WindowFramework:
TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

List of all members.

Public Types

enum  BackgroundType {
  BT_other = 0, BT_default, BT_black, BT_gray,
  BT_white, BT_none
}
enum  SplitType { ST_default, ST_horizontal, ST_vertical }

Public Member Functions

void adjust_dimensions ()
 Reevaluates the dimensions of the window, presumably after the window has been resized by the user or some other force.
void center_trackball (const NodePath &object)
 Centers the trackball on the indicated object, and scales the trackball motion suitably.
void enable_keyboard ()
 Creates a ButtonThrower to listen to button presses and throw them as events.
virtual TypeHandle force_init_type ()
bool get_anim_controls () const
 Returns the current state of the anim_controls flag.
NodePath get_aspect_2d ()
 Returns the node under the 2-d scene graph that is scaled to suit the window's aspect ratio.
BackgroundType get_background_type () const
 Returns the current background type setting.
NodePath get_button_thrower ()
 Returns the node in the data graph corresponding to the ButtonThrower object associated with this window.
Cameraget_camera (int n) const
 Returns the nth camera associated with the window.
NodePath get_camera_group ()
 Returns the node above the collection of 3-d cameras in the scene graph.
DisplayRegionget_display_region_2d () const
 Returns the default DisplayRegion created for the 2-d scene (render2d).
DisplayRegionget_display_region_3d () const
 Returns the default DisplayRegion created for the 3-d scene (render).
GraphicsOutputget_graphics_output () const
 Returns a pointer to the underlying GraphicsOutput object.
GraphicsWindowget_graphics_window () const
 Returns a pointer to the underlying GraphicsWindow object, if it is in fact a window; or NULL if it is not.
bool get_lighting () const
 Returns the current state of the lighting flag.
NodePath get_mouse ()
 Returns the node in the data graph corresponding to the mouse associated with this window.
int get_num_cameras () const
 Returns the number of 3-d cameras associated with the window.
bool get_one_sided_reverse () const
 Returns the current state of the one_sided_reverse flag.
PandaFrameworkget_panda_framework () const
 Returns a pointer to the associated PandaFramework object.
bool get_perpixel () const
 Returns the current state of the perpixel flag.
NodePath get_pixel_2d ()
 Returns a special root that uses units in pixels that are relative to the window.
NodePath get_render ()
 Returns the root of the 3-d scene graph.
NodePath get_render_2d ()
 Returns the root of the 2-d scene graph.
bool get_texture () const
 Returns the current state of the texture flag.
bool get_two_sided () const
 Returns the current state of the two_sided flag.
virtual TypeHandle get_type () const
bool get_wireframe () const
 Returns the current state of the wireframe flag.
NodePath load_default_model (const NodePath &parent)
 Loads our favorite blue triangle.
NodePath load_model (const NodePath &parent, Filename filename)
 Loads up the indicated model and returns the new NodePath, or the empty NodePath if the model could not be loaded.
bool load_models (const NodePath &parent, const pvector< Filename > &files)
 Loads up all the model files listed in the indicated argument list.
bool load_models (const NodePath &parent, int argc, char *argv[], int first_arg=1)
 Loads up all the model files listed in the indicated argument list.
void loop_animations (int hierarchy_match_flags=PartGroup::HMF_ok_part_extra|PartGroup::HMF_ok_anim_extra)
 Looks for characters and their matching animation files in the scene graph; binds and loops any matching animations found.
NodePath make_camera ()
 Makes a new 3-d camera for the window.
void next_anim_control ()
 Rotates the animation controls through all of the available animations.
void set_anim_controls (bool enable)
 Creates an onscreen animation slider for frame-stepping through the animations.
void set_background_type (BackgroundType type)
 Sets the background of the window to one of the pre-canned background types (or to BT_other, which indicates the user intends to set up his own special background mode).
void set_lighting (bool enable)
 Turns lighting on (true) or off (false).
void set_one_sided_reverse (bool enable)
 Toggles one-sided reverse mode.
void set_perpixel (bool enable)
 Turns per-pixel lighting on (true) or off (false).
void set_texture (bool enable)
 Forces textures off (false) or restores default rendering (true).
void set_two_sided (bool enable)
 Forces two-sided rendering (true) or restores default rendering (false).
void set_wireframe (bool enable)
 Forces wireframe state (true) or restores default rendering (false).
void setup_trackball ()
 Sets up the mouse to trackball around the camera.
WindowFrameworksplit_window (SplitType split_type=ST_default)
 Divides the window into two display regions, each of which gets its own trackball and keyboard events.
void stagger_animations ()
 Walks through all the animations that were bound by loop_animations() and staggers their play rate slightly so that they will not remain perfectly in sync.

Static Public Member Functions

static TypeHandle get_class_type ()
static TextFontget_shuttle_controls_font ()
 Returns a font that contains the shuttle controls icons.
static void init_type ()

Protected Member Functions

 WindowFramework (PandaFramework *panda_framework)
 WindowFramework (const WindowFramework &copy, DisplayRegion *display_region)
void close_window ()
 Closes the window or buffer.
GraphicsOutputopen_window (const WindowProperties &props, int flags, GraphicsEngine *engine, GraphicsPipe *pipe, GraphicsStateGuardian *gsg=NULL)
 Opens the actual window or buffer.
void setup_lights ()
 Makes light nodes and attaches them to the camera for viewing the scene.

Friends

class PandaFramework

Detailed Description

This encapsulates the data that is normally associated with a single window, or with a single display region within a window.

(In the case where a window has been subdivided with split_window(), there may be multiple WindowFrameworks objects that share the same GraphicsOutput pointer, but reference different display regions within that window).

Definition at line 55 of file windowFramework.h.


Member Function Documentation

void WindowFramework::adjust_dimensions ( )

Reevaluates the dimensions of the window, presumably after the window has been resized by the user or some other force.

Adjusts the render film size, aspect2d scale (aspect ratio) and the dimensionsas of pixel_2d according to the new window shape, or new config setting.

Definition at line 11100 of file windowFramework.cxx.

void WindowFramework::center_trackball ( const NodePath object)

Centers the trackball on the indicated object, and scales the trackball motion suitably.

Definition at line 10755 of file windowFramework.cxx.

Referenced by PandaFramework::event_c().

void WindowFramework::close_window ( ) [protected]

Closes the window or buffer.

This is normally called from PandaFramework::close_window().

Definition at line 10461 of file windowFramework.cxx.

Referenced by PandaFramework::close_all_windows().

void WindowFramework::enable_keyboard ( )

Creates a ButtonThrower to listen to button presses and throw them as events.

Definition at line 10695 of file windowFramework.cxx.

bool WindowFramework::get_anim_controls ( ) const [inline]

Returns the current state of the anim_controls flag.

Definition at line 106 of file windowFramework.I.

NodePath WindowFramework::get_aspect_2d ( )

Returns the node under the 2-d scene graph that is scaled to suit the window's aspect ratio.

Definition at line 10579 of file windowFramework.cxx.

Referenced by PandaFramework::event_f9(), and PandaFramework::event_question().

WindowFramework::BackgroundType WindowFramework::get_background_type ( ) const [inline]

Returns the current background type setting.

Definition at line 176 of file windowFramework.I.

Referenced by PandaFramework::event_comma().

NodePath WindowFramework::get_button_thrower ( )

Returns the node in the data graph corresponding to the ButtonThrower object associated with this window.

Definition at line 10684 of file windowFramework.cxx.

Camera * WindowFramework::get_camera ( int  n) const [inline]

Returns the nth camera associated with the window.

Definition at line 73 of file windowFramework.I.

NodePath WindowFramework::get_camera_group ( )

Returns the node above the collection of 3-d cameras in the scene graph.

This node may be moved around to represent the viewpoint.

Definition at line 10499 of file windowFramework.cxx.

DisplayRegion * WindowFramework::get_display_region_2d ( ) const [inline]

Returns the default DisplayRegion created for the 2-d scene (render2d).

Definition at line 85 of file windowFramework.I.

DisplayRegion * WindowFramework::get_display_region_3d ( ) const [inline]

Returns the default DisplayRegion created for the 3-d scene (render).

Definition at line 96 of file windowFramework.I.

GraphicsOutput * WindowFramework::get_graphics_output ( ) const [inline]
GraphicsWindow * WindowFramework::get_graphics_window ( ) const [inline]

Returns a pointer to the underlying GraphicsWindow object, if it is in fact a window; or NULL if it is not.

Definition at line 35 of file windowFramework.I.

bool WindowFramework::get_lighting ( ) const [inline]

Returns the current state of the lighting flag.

Definition at line 156 of file windowFramework.I.

Referenced by PandaFramework::event_l().

NodePath WindowFramework::get_mouse ( )

Returns the node in the data graph corresponding to the mouse associated with this window.

Definition at line 10649 of file windowFramework.cxx.

int WindowFramework::get_num_cameras ( ) const [inline]

Returns the number of 3-d cameras associated with the window.

A window usually has only one camera, but it may have multiple cameras if there are multiple display regions within the window.

Definition at line 63 of file windowFramework.I.

bool WindowFramework::get_one_sided_reverse ( ) const [inline]

Returns the current state of the one_sided_reverse flag.

Definition at line 146 of file windowFramework.I.

Referenced by PandaFramework::event_i().

PandaFramework * WindowFramework::get_panda_framework ( ) const [inline]

Returns a pointer to the associated PandaFramework object.

Definition at line 23 of file windowFramework.I.

bool WindowFramework::get_perpixel ( ) const [inline]

Returns the current state of the perpixel flag.

Definition at line 166 of file windowFramework.I.

Referenced by PandaFramework::event_p().

NodePath WindowFramework::get_pixel_2d ( )

Returns a special root that uses units in pixels that are relative to the window.

The upperleft corner of the window is (0, 0), the lowerleft corner is (xsize, -ysize), in this coordinate system.

Definition at line 10620 of file windowFramework.cxx.

NodePath WindowFramework::get_render ( )

Returns the root of the 3-d scene graph.

Definition at line 10512 of file windowFramework.cxx.

NodePath WindowFramework::get_render_2d ( )

Returns the root of the 2-d scene graph.

Definition at line 10531 of file windowFramework.cxx.

TextFont * WindowFramework::get_shuttle_controls_font ( ) [static]

Returns a font that contains the shuttle controls icons.

Definition at line 11425 of file windowFramework.cxx.

bool WindowFramework::get_texture ( ) const [inline]

Returns the current state of the texture flag.

Definition at line 126 of file windowFramework.I.

Referenced by PandaFramework::event_t().

bool WindowFramework::get_two_sided ( ) const [inline]

Returns the current state of the two_sided flag.

Definition at line 136 of file windowFramework.I.

Referenced by PandaFramework::event_b().

bool WindowFramework::get_wireframe ( ) const [inline]

Returns the current state of the wireframe flag.

Definition at line 116 of file windowFramework.I.

Referenced by PandaFramework::event_w().

NodePath WindowFramework::load_default_model ( const NodePath parent)

Loads our favorite blue triangle.

This is intended to provide some default geometry to have *something* to look at for testing, when no other models are provided.

Definition at line 10959 of file windowFramework.cxx.

NodePath WindowFramework::load_model ( const NodePath parent,
Filename  filename 
)

Loads up the indicated model and returns the new NodePath, or the empty NodePath if the model could not be loaded.

Definition at line 10888 of file windowFramework.cxx.

bool WindowFramework::load_models ( const NodePath parent,
int  argc,
char *  argv[],
int  first_arg = 1 
)

Loads up all the model files listed in the indicated argument list.

If first_arg is supplied, it is the first argument in the list to consider.

Returns true if all models loaded successfully, or false if at least one of them had an error.

Definition at line 10845 of file windowFramework.cxx.

bool WindowFramework::load_models ( const NodePath parent,
const pvector< Filename > &  files 
)

Loads up all the model files listed in the indicated argument list.

Returns true if all models loaded successfully, or false if at least one of them had an error.

Definition at line 10865 of file windowFramework.cxx.

void WindowFramework::loop_animations ( int  hierarchy_match_flags = PartGroup::HMF_ok_part_extra | PartGroup::HMF_ok_anim_extra)

Looks for characters and their matching animation files in the scene graph; binds and loops any matching animations found.

Definition at line 11019 of file windowFramework.cxx.

NodePath WindowFramework::make_camera ( )

Makes a new 3-d camera for the window.

Definition at line 11449 of file windowFramework.cxx.

void WindowFramework::next_anim_control ( )

Rotates the animation controls through all of the available animations.

If the animation controls are not already enabled, enables them at sets to the first animation; if they are already enabled, steps to the next animation; if that is the last animation, disables the animation controls.

Definition at line 11056 of file windowFramework.cxx.

Referenced by PandaFramework::event_a().

GraphicsOutput * WindowFramework::open_window ( const WindowProperties props,
int  flags,
GraphicsEngine engine,
GraphicsPipe pipe,
GraphicsStateGuardian gsg = NULL 
) [protected]

Opens the actual window or buffer.

This is normally called only from PandaFramework::open_window().

Definition at line 10407 of file windowFramework.cxx.

void WindowFramework::set_anim_controls ( bool  enable)

Creates an onscreen animation slider for frame-stepping through the animations.

Definition at line 11079 of file windowFramework.cxx.

void WindowFramework::set_background_type ( WindowFramework::BackgroundType  type)

Sets the background of the window to one of the pre-canned background types (or to BT_other, which indicates the user intends to set up his own special background mode).

Definition at line 11363 of file windowFramework.cxx.

Referenced by PandaFramework::event_comma(), and PandaFramework::set_background_type().

void WindowFramework::set_lighting ( bool  enable)

Turns lighting on (true) or off (false).

Definition at line 11312 of file windowFramework.cxx.

Referenced by PandaFramework::event_l(), and PandaFramework::set_lighting().

void WindowFramework::set_one_sided_reverse ( bool  enable)

Toggles one-sided reverse mode.

In this mode, the front sides of one-sided polygons are culled instead of the back side.

Definition at line 11286 of file windowFramework.cxx.

Referenced by PandaFramework::event_i().

void WindowFramework::set_perpixel ( bool  enable)

Turns per-pixel lighting on (true) or off (false).

Definition at line 11338 of file windowFramework.cxx.

Referenced by PandaFramework::event_p(), and PandaFramework::set_perpixel().

void WindowFramework::set_texture ( bool  enable)

Forces textures off (false) or restores default rendering (true).

Definition at line 11236 of file windowFramework.cxx.

Referenced by PandaFramework::event_t(), and PandaFramework::set_texture().

void WindowFramework::set_two_sided ( bool  enable)

Forces two-sided rendering (true) or restores default rendering (false).

Definition at line 11259 of file windowFramework.cxx.

Referenced by PandaFramework::event_b(), and PandaFramework::set_two_sided().

void WindowFramework::set_wireframe ( bool  enable)

Forces wireframe state (true) or restores default rendering (false).

Definition at line 11205 of file windowFramework.cxx.

Referenced by PandaFramework::event_w(), and PandaFramework::set_wireframe().

void WindowFramework::setup_lights ( ) [protected]

Makes light nodes and attaches them to the camera for viewing the scene.

Definition at line 11485 of file windowFramework.cxx.

void WindowFramework::setup_trackball ( )

Sets up the mouse to trackball around the camera.

Definition at line 10726 of file windowFramework.cxx.

WindowFramework * WindowFramework::split_window ( SplitType  split_type = ST_default)

Divides the window into two display regions, each of which gets its own trackball and keyboard events.

The new window pointer is returned.

There is not an interface for recombining divided windows.

Definition at line 11156 of file windowFramework.cxx.

void WindowFramework::stagger_animations ( )

Walks through all the animations that were bound by loop_animations() and staggers their play rate slightly so that they will not remain perfectly in sync.

Definition at line 11036 of file windowFramework.cxx.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations