esve::viewers::dim3::Canned_Viewer Class Reference

A prepackaged, shrink-wrapped viewer stuffed into a can. More...

#include <esve/viewers/dim3/Canned_Viewer.hxx>

Inheritance diagram for esve::viewers::dim3::Canned_Viewer:

List of all members.

Public Member Functions
virtual void	add_geom (engine::dim3::Geom &)
	Add a Geom.
virtual void	remove_geom (engine::dim3::Geom &)
	Remove a Geom.
virtual void	stop_motion ()
	Stop the motion handler.
Camera &	create_camera (const std::string &=default_camera_label, const Camera::Rectangle &=default_camera_rectangle)
	Cameras.
virtual int	takeover ()
	Shorthand for peek_kernel().takeover().
virtual Light &	create_light ()
	Lights.
void	scaling (types::real)
	Scaling applied to all added geoms.
types::real	scaling () const
	Scaling applied to all added geoms.
virtual const engine::dim3::Transform &	rotation () const
	Rotation applied to all added geoms.
virtual void	rotation (const types::quat &)
	Rotation applied to all added geoms.
virtual const engine::dim3::Transform &	home_transform () const
	Reset to this transform.
virtual void	home_transform (const engine::dim3::Transform &)
	Reset to this transform.
virtual bool	stars_active () const
	Whether stars are showing.
virtual void	stars_active (bool)
	Whether stars are showing.
virtual void	add_handler (components::dimn::Motion_Handler &)
	Motion handlers.
virtual void	remove_handler (components::dimn::Motion_Handler &)
	Motion handlers.
virtual void	add_handler (kernel::Handler &)
	Regular handlers.
virtual void	remove_handler (kernel::Handler &)
	Regular handlers.
virtual void	add_frame (engine::dim3::Frame &)
	Frames.
virtual void	remove_frame (engine::dim3::Frame &)
	Frames.
Protected Member Functions
void	modal_tie (ui::extra::Modal_Tie &)
	Take advantage of a modal tie.
types::real	sensitivity () const
	Motion sensitivity read at command line.
message::Draw_Sender &	peek_draw_sender ()
	The shared (lit) draw node.
message::Draw_Sender &	peek_unlit_draw_sender ()
	The shared unlit draw node.
message::Draw_Sender &	peek_draw_initializer ()
	The shared initialize node.
message::Compute_Sender &	peek_compute_sender ()
	The shared compute node.
kernel::Simple_Kernel &	peek_kernel ()
	Peek at the kernel.
Command_Line_Arguments_iterator	arguments_begin () const
	Non-option command-line arguments.
Command_Line_Arguments_iterator	arguments_end () const
	Non-option command-line arguments.

---

Detailed Description

A prepackaged, shrink-wrapped viewer stuffed into a can.

Note the override of add_geom(), which makes the added geom a child of the rotation frame.

This class encapsulates most of the implementation for Simple_Viewer.

---

Member Function Documentation

virtual void esve::viewers::dim3::Canned_Viewer::add_geom (  engine::dim3::Geom &   )  [virtual]

Add a Geom. (Override.) The Geom is added to the shared compute node, to the shared draw node, and to the rotation frame. Reimplemented from esve::viewers::dim3::Basic_Viewer.

virtual void esve::viewers::dim3::Canned_Viewer::remove_geom (  engine::dim3::Geom &   )  [virtual]

Remove a Geom. (Override.) The Geom is removed compute node, from the shared draw node, and from the rotation frame or the root frame (if either was a direct child). Reimplemented from esve::viewers::dim3::Basic_Viewer.

Camera& esve::viewers::dim3::Starry_Viewer::create_camera (  const std::string &  = default_camera_label, const Camera::Rectangle &  = default_camera_rectangle )  [virtual, inherited]

Cameras. The camera is a child of the root frame. The viewer owns the camera. Reimplemented from esve::viewers::dim3::Basic_Viewer.

virtual Light& esve::viewers::dim3::Basic_Viewer::create_light (   )  [virtual, inherited]

Lights. The light is a child of the root frame. All lights are enabled for the shared draw node. The viewer owns the light.

virtual void esve::viewers::dim3::Basic_Viewer::add_handler (  components::dimn::Motion_Handler &   )  [virtual, inherited]

Motion handlers. The handler will receive handle_check_awake() and update(dt) messages with a time delta dt. Implements esve::viewers::dimn::Minimal_Viewer.

virtual void esve::viewers::dim3::Basic_Viewer::remove_handler (  components::dimn::Motion_Handler &   )  [virtual, inherited]

Motion handlers. It will be removed from the handle tree and the update tree. Implements esve::viewers::dimn::Minimal_Viewer.

virtual void esve::viewers::dim3::Basic_Viewer::add_frame (  engine::dim3::Frame &   )  [virtual, inherited]

Frames. The frame is made a child of the root frame.

virtual void esve::viewers::dim3::Basic_Viewer::remove_frame (  engine::dim3::Frame &   )  [virtual, inherited]

Frames. The frame is orphaned from the root frame (if it was a direct child).

---