orca-robotics


INTRODUCTION
Overview
Download and Install
Quick Start
Documentation
Publications

REPOSITORY
Interfaces
Components
Libraries
Utilities
Software Map

DEVELOPER
Tutorials
Examples
Dev Guide
Dashboard
Wiki
login/pass: orca/orca

PEOPLE
Contributors
Users

SourceForge.net Logo
Project
Download
Mailing lists

 

         

PixMap

An planar pixel representation of the world. More...

Classes

struct  orca::Pixel
 Represents a single pixel encoded as Red-Green-Blue intensities. More...
struct  orca::PixMapData
 Data for PixMap interface. More...
interface  orca::PixMapConsumer
interface  orca::PixMap
 Access to pixMap. More...
interface  orca::PixMap
 Access to pixMap. More...

Functions

void orca::PixMap::subscribe (PixMapConsumer *subscriber) throws SubscriptionFailedException
idempotent void orca::PixMap::unsubscribe (PixMapConsumer *subscriber)

Variables

byte orca::Pixel::g
 Green intensity.
byte orca::Pixel::b
 Blue intensity.
sequence< Pixel > orca::Pixels
 A sequence of pixels representing an image.
Frame2d orca::PixMapData::offset
int orca::PixMapData::numCellsX
 The number of cells along the x axis.
int orca::PixMapData::numCellsY
 The number of cells along the y axis.
float orca::PixMapData::metresPerCellX
 The size of each cell, in the x dimension.
float orca::PixMapData::metresPerCellY
 The size of each cell, in the y dimension.
Pixels orca::PixMapData::rgbPixels
 The rgb pixel values.

Detailed Description

An planar pixel representation of the world.

PixMap is a pixel-based map which can be used as a background map for a GUI for instance. The data is encoded as pixels with rgb values.

See also:
OgMap for coordinate system conventions.

Function Documentation

void orca::PixMap::subscribe PixMapConsumer subscriber  )  throws SubscriptionFailedException [inherited]
 

Mimics IceStorm's subscribe(). subscriber is typically a direct proxy to the consumer object. The implementation may choose to implement the push directly or use IceStorm. This choice is transparent to the subscriber. The case when the subscriber is already subscribed is quietly ignored.

See also:
unsubscribe

idempotent void orca::PixMap::unsubscribe PixMapConsumer subscriber  )  [inherited]
 

Unsubscribe an existing subscriber. The case when the subscriber is not subscribed is quietly ignored.

See also:
subscribe


Variable Documentation

Frame2d orca::PixMapData::offset [inherited]
 

Transformation from the global (arbitrarily defined) coordinate system (CS) to the CS of the pixmap. The pixmap CS is defined as as follows:

  • origin at the bottom-left corner
  • X axis along the bottom edge to the right
  • Y axis along the left edge up Example: if the global CS starts in the middle of a pixmap and there are no rotations, then the pixmap offset is (-width/2, -height/2, 0).

 

Webmaster: Tobias Kaupp (tobasco at users.sourceforge.net)


Generated for Orca Robotics by  doxygen 1.4.5