Panda3D
sequenceNode.h
Go to the documentation of this file.
1 /**
2  * PANDA 3D SOFTWARE
3  * Copyright (c) Carnegie Mellon University. All rights reserved.
4  *
5  * All use of this software is subject to the terms of the revised BSD
6  * license. You should have received a copy of this license along
7  * with this source code in a file named "LICENSE."
8  *
9  * @file sequenceNode.h
10  * @author drose
11  * @date 2002-03-06
12  */
13 
14 #ifndef SEQUENCENODE_H
15 #define SEQUENCENODE_H
16 
17 #include "pandabase.h"
18 
19 #include "selectiveChildNode.h"
20 #include "animInterface.h"
21 #include "clockObject.h"
22 
23 /**
24  * A node that automatically cycles through rendering each one of its children
25  * according to its frame rate.
26  */
27 class EXPCL_PANDA_PGRAPHNODES SequenceNode : public SelectiveChildNode, public AnimInterface {
28 PUBLISHED:
29  INLINE explicit SequenceNode(const std::string &name);
30 
31 protected:
32  SequenceNode(const SequenceNode &copy);
33 
34 PUBLISHED:
35  virtual int get_num_frames() const;
36  INLINE void set_frame_rate(double frame_rate);
37 
38 public:
39  virtual PandaNode *make_copy() const;
40  virtual bool safe_to_combine() const;
41  virtual bool safe_to_combine_children() const;
42 
43  virtual bool cull_callback(CullTraverser *trav, CullTraverserData &data);
44  virtual int get_first_visible_child() const;
45  virtual bool has_single_child_visibility() const;
46  virtual int get_visible_child() const;
47 
48  virtual void output(std::ostream &out) const;
49 
50 public:
51  static void register_with_read_factory();
52  virtual void write_datagram(BamWriter *manager, Datagram &dg);
53 
54 protected:
55  static TypedWritable *make_from_bam(const FactoryParams &params);
56  void fillin(DatagramIterator &scan, BamReader *manager);
57 
58 public:
59  static TypeHandle get_class_type() {
60  return _type_handle;
61  }
62  static void init_type() {
63  SelectiveChildNode::init_type();
64  AnimInterface::init_type();
65  register_type(_type_handle, "SequenceNode",
66  SelectiveChildNode::get_class_type(),
67  AnimInterface::get_class_type());
68  }
69  virtual TypeHandle get_type() const {
70  return get_class_type();
71  }
72  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
73 
74 private:
75  static TypeHandle _type_handle;
76 };
77 
78 #include "sequenceNode.I"
79 
80 #endif
virtual int get_visible_child() const
Returns the index number of the currently visible child of this node.
Definition: pandaNode.cxx:457
A basic node of the scene graph or data graph.
Definition: pandaNode.h:64
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
virtual void write_datagram(BamWriter *manager, Datagram &dg)
Writes the contents of this object to the datagram for shipping out to a Bam file.
Definition: pandaNode.cxx:3589
This is the fundamental interface for extracting binary objects from a Bam file, as generated by a Ba...
Definition: bamReader.h:110
Base class for objects that can be written to and read from Bam files.
Definition: typedWritable.h:35
void register_type(TypeHandle &type_handle, const std::string &name)
This inline function is just a convenient way to call TypeRegistry::register_type(),...
Definition: register_type.I:22
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
virtual bool safe_to_combine_children() const
Returns true if it is generally safe to combine the children of this PandaNode with each other.
Definition: pandaNode.cxx:244
This collects together the pieces of data that are accumulated for each node while walking the scene ...
A node that automatically cycles through rendering each one of its children according to its frame ra...
Definition: sequenceNode.h:27
A base class for nodes like LODNode and SequenceNode that select only one visible child at a time.
This is the fundamental interface for writing binary objects to a Bam file, to be extracted later by ...
Definition: bamWriter.h:63
This is the fundamental interface for things that have a play/loop/stop type interface for frame-base...
Definition: animInterface.h:35
static void register_with_read_factory()
Tells the BamReader how to create objects of type PandaNode.
Definition: pandaNode.cxx:3580
virtual bool safe_to_combine() const
Returns true if it is generally safe to combine this particular kind of PandaNode with other kinds of...
Definition: pandaNode.cxx:234
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
virtual int get_first_visible_child() const
Returns the index number of the first visible child of this node, or a number >= get_num_children() i...
An instance of this class is passed to the Factory when requesting it to do its business and construc...
Definition: factoryParams.h:36
virtual PandaNode * make_copy() const
Returns a newly-allocated PandaNode that is a shallow copy of this one.
Definition: pandaNode.cxx:487
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
virtual bool has_single_child_visibility() const
Should be overridden by derived classes to return true if this kind of node has the special property ...
Definition: pandaNode.cxx:448
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
A class to retrieve the individual data elements previously stored in a Datagram.
TypeHandle is the identifier used to differentiate C++ class types.
Definition: typeHandle.h:81
An ordered list of data elements, formatted in memory for transmission over a socket or writing to a ...
Definition: datagram.h:38
This object performs a depth-first traversal of the scene graph, with optional view-frustum culling,...
Definition: cullTraverser.h:45