submesh_node Class Reference

Inheritance diagram for submesh_node:

Inheritance graph
[legend]
Collaboration diagram for submesh_node:

Collaboration graph
[legend]

List of all members.


Detailed Description

A submesh_node holds number of submeshes, to be drawn either in the opaque or translucent group.

Definition at line 730 of file model.cpp.


Scene Graph Functionality.

void add_child (node *child)
 Add a child node. Also sets the child's parent to this.
bool connect (node *branch)
 If this is called on the root of a scene graph, it will insert the branch node in the appropriate place in the graph, or return false.
void detach ()
 Removes the node from the scene graph (does not delete it!).
gsgl::flags_tget_draw_flags ()
const gsgl::flags_tget_draw_flags () const
gsgl::flags_tget_draw_results ()
const gsgl::flags_tget_draw_results () const
enum  node_draw_flags { NODE_NO_DRAW_FLAGS = 0, NODE_NO_FRUSTUM_CHECK = 1 << 0, NODE_DUMMY_OBJECT = 1 << 2, NODE_DRAW_UNLIT = 1 << 3 }
 Flags that control node drawing. More...
enum  node_draw_results { NODE_NO_DRAW_RESULTS = 0, NODE_OFF_SCREEN = 1 << 0, NODE_DREW_POINT = 1 << 1, NODE_DISTANCE_CULLED = 1 << 2 }
 Flags that indicate what happened when the node was drawn. More...
static void draw_scene (gsgl::scenegraph::context *c, pre_draw_rec &rec)
 Draws a scene. Safe to call while update is also being called in the tree.
static void pre_draw_scene (gsgl::scenegraph::context *c, pre_draw_rec &rec)
 Collect information about the scene to draw. Unsafe to call while update is being called in the tree.

Drawing Information Functions.

virtual gsgl::real_t default_view_distance () const
virtual gsgl::real_t minimum_view_distance () const
static const gsgl::real_t NODE_DRAW_FIRST = FLT_MAX
static const gsgl::real_t NODE_DRAW_IGNORE = 0.000f
static const gsgl::real_t NODE_DRAW_SOLID = 0.001f
static const gsgl::real_t NODE_DRAW_TRANSLUCENT = 0.002f

Public Member Functions

virtual void cleanup (gsgl::scenegraph::context *c)
 Called when the simulation is done.
virtual void draw (gsgl::scenegraph::context *c)
 Called to draw the node. The node's modelview matrix is in the correct state for drawing, and already loaded into the OpenGL modelview matrix.
bool get_opaque ()
virtual gsgl::real_t get_priority (gsgl::scenegraph::context *)
 Called to determine the draw priority of the node.
simple_array< submesh * > & get_submeshes ()
virtual const gsgl::stringget_type_name () const
virtual void init (gsgl::scenegraph::context *c)
 Called when the simulation is created. The node's modelview matrix is invalid at this point.
virtual gsgl::real_t max_extent () const
 Should return the maximum extent of the object (in the node's coordinates, i.e. not scaled to meters).
 submesh_node (const string &name, node *parent, bool opaque)
virtual void update (gsgl::scenegraph::context *c)
 Called from the root of the world-tree up to update the node's state. The node's modelview matrix is that of the previously-drawn frame.
virtual ~submesh_node ()
Accessors.
data::simple_array< node * > & get_children ()
math::transformget_modelview ()
stringget_name ()
const stringget_name () const
math::transformget_orientation ()
node *& get_parent ()
const nodeget_parent () const
stringget_parent_name ()
gsgl::real_tget_scale ()
math::vectorget_translation ()
Node Life Cycle.
virtual bool handle_event (gsgl::scenegraph::context *c, sg_event &e)
 Called with events.
virtual data::config_recordsave () const
 Called to save the node to a config_record structure.

Private Attributes

gsgl::real_t cached_max_extent
bool opaque
simple_array< submesh * > submeshes

Member Enumeration Documentation

enum node_draw_flags [inherited]

Flags that control node drawing.

Enumerator:
NODE_NO_DRAW_FLAGS 
NODE_NO_FRUSTUM_CHECK  Don't perform a frustum check when drawing this node.
NODE_DUMMY_OBJECT  This node should never be drawn.
NODE_DRAW_UNLIT  This node should not be lit.

Definition at line 141 of file node.hpp.

enum node_draw_results [inherited]

Flags that indicate what happened when the node was drawn.

Enumerator:
NODE_NO_DRAW_RESULTS 
NODE_OFF_SCREEN  The node was not drawn because it was out-of-frame.
NODE_DREW_POINT  The node was drawn as a point.
NODE_DISTANCE_CULLED  The node was not drawn due to distance.

Definition at line 157 of file node.hpp.


Constructor & Destructor Documentation

submesh_node ( const string name,
node parent,
bool  opaque 
)

Definition at line 756 of file model.cpp.

~submesh_node (  )  [virtual]

Definition at line 762 of file model.cpp.


Member Function Documentation

void add_child ( node child  )  [inherited]

Add a child node. Also sets the child's parent to this.

Definition at line 267 of file node.cpp.

References assert, node::children, and node::parent.

Referenced by node::connect(), application::load_objects(), application::load_scenery(), model::model(), node::node(), vehicle::vehicle(), and vehicle_module::vehicle_module().

void cleanup ( gsgl::scenegraph::context c  )  [virtual]

Called when the simulation is done.

Reimplemented from node.

Definition at line 848 of file model.cpp.

References submesh_node::submeshes.

bool connect ( node branch  )  [inherited]

If this is called on the root of a scene graph, it will insert the branch node in the appropriate place in the graph, or return false.

Definition at line 289 of file node.cpp.

References node::add_child(), node::children, node::name, and node::parent_name.

Referenced by simulation::simulation().

gsgl::real_t default_view_distance (  )  const [virtual, inherited]

Reimplemented in vehicle, checkered_box, celestial_body, and large_lithosphere.

Definition at line 255 of file node.cpp.

Referenced by large_lithosphere::default_view_distance(), and freeview::reset().

void detach (  )  [inherited]

Removes the node from the scene graph (does not delete it!).

Definition at line 276 of file node.cpp.

References node::children, and node::parent.

void draw ( gsgl::scenegraph::context c  )  [virtual]

Called to draw the node. The node's modelview matrix is in the correct state for drawing, and already loaded into the OpenGL modelview matrix.

Reimplemented from node.

Definition at line 833 of file model.cpp.

References context::render_flags, and submesh_node::submeshes.

void draw_scene ( gsgl::scenegraph::context c,
pre_draw_rec rec 
) [static, inherited]

data::simple_array< node * > & get_children (  )  [inherited]

gsgl::flags_t& get_draw_flags (  )  [inline, inherited]

Returns:
The node's draw flags (a bitset using node_draw_flags).

Definition at line 153 of file node.hpp.

const gsgl::flags_t& get_draw_flags (  )  const [inline, inherited]

gsgl::flags_t& get_draw_results (  )  [inline, inherited]

Returns:
The node's draw results (a bitset using node_draw_results).

Definition at line 169 of file node.hpp.

const gsgl::flags_t& get_draw_results (  )  const [inline, inherited]

Returns:
The node's draw results (a bitset using node_draw_results).

Definition at line 166 of file node.hpp.

Referenced by large_rocky_body::draw(), celestial_body::draw(), and large_lithosphere::update().

math::transform & get_modelview (  )  [inherited]

string & get_name (  )  [inherited]

Definition at line 205 of file node.cpp.

References node::name.

const string & get_name (  )  const [inherited]

bool get_opaque (  )  [inline]

Definition at line 742 of file model.cpp.

math::transform & get_orientation (  )  [inherited]

node *& get_parent (  )  [inherited]

Definition at line 168 of file node.cpp.

References node::parent.

const node * get_parent (  )  const [inherited]

string & get_parent_name (  )  [inherited]

Definition at line 210 of file node.cpp.

References node::parent_name.

gsgl::real_t get_priority ( gsgl::scenegraph::context  )  [virtual]

Called to determine the draw priority of the node.

A value of NODE_DRAW_IGNORE means don't draw (invisible nodes or nodes that are drawn by their parents -- the modelview matrix is still built). A value of NODE_DRAW_SOLID means the object is solid and should be drawn after the painter's algorithm. A value of NODE_DRAW_TRANSLUCENT means the object is translucent and should be drawn after solid objects. A value > NODE_DRAW_TRANSLUCENT is interpreted as the distance to the object. Objects that return > 2.0 are drawn with a painter's algorithm.

Reimplemented from node.

Definition at line 768 of file model.cpp.

References node::NODE_DRAW_SOLID, node::NODE_DRAW_TRANSLUCENT, and submesh_node::opaque.

gsgl::real_t & get_scale (  )  [inherited]

Definition at line 215 of file node.cpp.

References node::scale.

Referenced by stellar_db::draw(), gsgl::scenegraph::utils::greatest_extent(), and stellar_db::init().

simple_array<submesh *>& get_submeshes (  )  [inline]

Definition at line 743 of file model.cpp.

Referenced by model_part::model_part().

math::vector & get_translation (  )  [inherited]

const gsgl::string & get_type_name (  )  const [virtual, inherited]

Definition at line 54 of file broker.cpp.

References countable::is_empty(), and brokered_object::type_name.

Referenced by node::draw_scene(), and simulation::update_node().

bool handle_event ( gsgl::scenegraph::context c,
sg_event e 
) [virtual, inherited]

Called with events.

Reimplemented in freeview.

Definition at line 323 of file node.cpp.

Referenced by simulation::handle_event().

void init ( gsgl::scenegraph::context c  )  [virtual]

Called when the simulation is created. The node's modelview matrix is invalid at this point.

Reimplemented from node.

Definition at line 823 of file model.cpp.

References submesh_node::submeshes.

gsgl::real_t max_extent (  )  const [virtual]

Should return the maximum extent of the object (in the node's coordinates, i.e. not scaled to meters).

Reimplemented from node.

Definition at line 795 of file model.cpp.

References submesh_node::cached_max_extent, and submesh_node::submeshes.

gsgl::real_t minimum_view_distance (  )  const [virtual, inherited]

void pre_draw_scene ( gsgl::scenegraph::context c,
pre_draw_rec rec 
) [static, inherited]

Collect information about the scene to draw. Unsafe to call while update is being called in the tree.

Definition at line 380 of file node.cpp.

References node::build_draw_list(), context::cam, transform::IDENTITY, node::pre_draw_rec::light_queue, node::pre_draw_rec::paint_queue, node::pre_draw_rec::solids, and node::pre_draw_rec::translucents.

Referenced by simulation::pre_draw().

data::config_record * save (  )  const [virtual, inherited]

Called to save the node to a config_record structure.

Definition at line 328 of file node.cpp.

void update ( gsgl::scenegraph::context c  )  [virtual]

Called from the root of the world-tree up to update the node's state. The node's modelview matrix is that of the previously-drawn frame.

Reimplemented from node.

Definition at line 843 of file model.cpp.


Member Data Documentation

gsgl::real_t cached_max_extent [mutable, private]

Definition at line 736 of file model.cpp.

Referenced by submesh_node::max_extent().

const gsgl::real_t NODE_DRAW_FIRST = FLT_MAX [static, inherited]

const gsgl::real_t NODE_DRAW_IGNORE = 0.000f [static, inherited]

const gsgl::real_t NODE_DRAW_SOLID = 0.001f [static, inherited]

Definition at line 216 of file node.hpp.

Referenced by node::build_draw_list(), and submesh_node::get_priority().

const gsgl::real_t NODE_DRAW_TRANSLUCENT = 0.002f [static, inherited]

bool opaque [private]

Definition at line 733 of file model.cpp.

Referenced by submesh_node::get_priority().


The documentation for this class was generated from the following file:

Generated on Sat Mar 1 13:50:07 2008 for Periapsis Project by  doxygen 1.5.5