Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

WorldViews Class Reference

#include <worldviews.h>

Inheritance diagram for WorldViews:

Inheritance graph
[legend]
Collaboration diagram for WorldViews:

Collaboration graph
[legend]
List of all members.

Detailed Description

Set of Retinal_Objects representing the views seen by a set of eyes.

Definition at line 61 of file worldviews.h.

Interface iterating over eyes; should be used only for output

typedef Retinal_Compositevalue_type
 Type to hold view of world.

typedef std::vector< value_typevector_type
 Type of container of world views.

typedef vector_type::iterator iterator
 Iterator over the container of world views.

typedef vector_type::const_iterator const_iterator
 Iterator over the container of world views.

iterator begin ()
 Underlying container's begin().

iterator end ()
 Underlying container's end().

const_iterator begin () const
 Underlying container's begin().

const_iterator end () const
 Underlying container's end().


Public Methods

virtual void uninit ()
 Reset to initial, undefined state.

virtual void define (const string &regionname, const double height, const double width)
 Add a new region with the given name.

virtual void generate_default_contents ()
 Generate default contents for each eye; optional.

virtual void reset ()
 Reset each object and the stream of random numbers to their initial values.

virtual void reset (long int seed)
 Reset each object to their initial values, and set the stream of random numbers to the given seed value.

virtual bool next ()
 Advance to the next state (whatever that means for this object).

const Retinal_Objview (int eye) const
 This interface should be avoided if at all possible, since it exposes that a WorldView is a Retinal_Object.

This interface probably needs changing; maybe some can be eliminated
bool has_been_defined () const
bool create_object (StringArgs arglist, const string &name, WorldViews &reference_contents, bool link_eyes=true)
 Create a Retinal_Object and add it to the given set of contents.

void remove_object (const string &parent="", const string &name="")
 Remove the given object from the given parent.

void print_object (const string &parent="", const string &name="") const
 Print all objects matching the given parent and name.

bool is_empty () const
 Returns true if no object has been defined yet.

External interface to a select few quantities needed by other files.
virtual bool is_active (int objnumber, int eye) const
 Whether the given object is currently enabled in the given eye.

virtual double angle_of_object (int objnumber, int eye) const
 The angle, in radians, of the given object in the given eye.

virtual double angle_of_object_at_location (int i, int j, int eye) const
 Returns the nominal angle of the most active object at the given location in the given eye.


Static Public Methods

void set_current_eye (int eye)
 Routines that parse string input for each eye call this function to make input_current_eye available for expressions.

void register_params_and_commands (void)
 This function must be called before any other member function call.

cmdstat set_distribution (int dist, bool &changed)
 Obsolete; should only be used by distribution_setfn.


Member Function Documentation

void WorldViews::define const string &    regionname,
const double    height,
const double    width
[virtual]
 

Add a new region with the given name.

If one already exists, just changes the height and width to the new values.

Definition at line 608 of file worldviews.c.

References Retinal_Composite::AccumulationType, Generic::insert_named(), Retinal_AnchoredManagedComposite::resize(), and ValueGeneratorMap< Variable >::set().

void WorldViews::generate_default_contents   [virtual]
 

Generate default contents for each eye; optional.

Usually you will want to check is_empty() first and call this only if so.

Definition at line 570 of file worldviews.c.

Referenced by Eyes::init().


The documentation for this class was generated from the following files:
Generated on Mon Jan 20 02:37:31 2003 for RF-LISSOM by doxygen1.3-rc2