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

Retinal_PGM Class Reference

#include <retinalobjs.h>

Inheritance diagram for Retinal_PGM:

Inheritance graph
[legend]
Collaboration diagram for Retinal_PGM:

Collaboration graph
[legend]
List of all members.

Detailed Description

Retinal_Object for a greyscale PGM bitmap read from a file.

Definition at line 859 of file retinalobjs.h.

Public Methods

 Retinal_PGM (const string &name_val, const string &filename_base, const VarMap &init_vars=VarMap())
RetinalObjectStringArgs::ParamList paramlist ()
 Retinal_PGM (const string &name_val, RetinalObjectStringArgs &sa, Retinal_Composite *parent)
 Retinal_PGM (const Retinal_PGM &b)
virtual bool update () const
 Must be called just before calling activation() one or more times.

virtual Retinal_Objectclone () const
 Return an identical copy of this object allocated from the heap.

virtual string stringrep () const
 (Partial) representation of this object's state as a string

virtual bool inside (Coordinate x, Coordinate y) const
 Returns true if the given coordinate is inside the active area of this object, favoring the most precise response possible, regardless of performance.


Member Function Documentation

bool Retinal_PGM::inside Coordinate    x,
Coordinate    y
const [virtual]
 

Returns true if the given coordinate is inside the active area of this object, favoring the most precise response possible, regardless of performance.

A rectangular bounding box will suffice, but if an object can give a more precise answer, e.g. if it really has a circular or irregular shape instead of a box, it should give the more precise answer here. This call should be used only when such precision is needed; the regular rectangular bounding box can be used in other cases.

Reimplemented from Retinal_Object.

Definition at line 964 of file retinalobjs.c.

References Retinal_Obj::Activity, and Retinal_Object::bounding_box.


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