User manual

old releases - latest release - trunk

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
ActionAbstract base class for all actions
ActionMonitorMonitors the outcome of an aggregated action and reports it back to the proxy
ActionResultContainerStores an ActionResult, of any type that can be serialized, deserialized and constructed by the the ActionResultFactory
ActionRouterHandles routing Actions from the poster to the designated target
ActionTransporterThe class that manages and oversees the operations of a set of ClientConnections. It listens for and handles new connections and performs some of the grunt, low-level socket operations
AlphaA statelet that toggles the alpha value used for blending
AtomModels the concept of a configuration atom
AuthenticatedStateThe state handler for authenticated connections
BlendModeA statelet that toggles and controls blending
BoundingVolumePolymorphic bounding volume class
BrowserFrameRepresents scene browser frames
BrowserTriggerTrigger for updating BrowserFrame objects when objects are modified in the scene
BundleAn action that ensures that all actions added to it are executed in the same frame
CameraGroupA group for setting camera properties
CameraObjectClass representing cameras in the scene
CameraPropertyTriggerTrigger for updating the cameraProperty fields in aCameraGroup
CameraProxyProxy class used to add and manipulate cameras
CameraProxyBaseBase class for CameraProxy
ChunkedBufferA dynamically growing buffer that grows in large chunks
ChunkedBuffer::ChunkA chunk of buffer data
ChunkedBuffer::NodeThe basic building block of the larger chunked buffer. A node contains a chunk of data and pointer to the next and previous nodes in the buffer
CircleObjectClass representing the circle geometric primitive
CircleProxyProxy class used to add and manipulate circles
CircleProxyBaseBase class for CircleProxy
ClientConnectionProvides "low-level" interface for sending and receiving data to a remote client
ClientConnection::IntermediaryBufferA small, uncomplicated intermediary send buffer, with no wrap-around
ClientImplProvides a middle-level interface, seated below Proxy, for communicating with a peekabot server. Deals with the intrinsic data pertaining to status and result requests and talks to lower level interfaces
ColorControls the diffuse and ambient reflectance
ColorGroupA group of properties and controls for setting color properties
ColorPointerControls which buffer is used to source color data to OpenGL rendering commands (e.g. glDrawElements)
ColorTriggerTrigger for updating the color chooser in aColorGroup
ConfigurationA configuration facility that can save and load itself to and from human readable, XML-formatted files
ConnectionObserverAn interface for being notified of ClientConnection events
ConnectionStateA client connection's state information and accompanying procedures encapsulated in an object. Plugs in to ClientConnection
ConsoleFrameRepresents console frames
CoordinateTriggerTrigger for updating the coordinate fields in aMoveRotateGroup
CubeObjectClass representing the cube geometric primitive
CubeProxyProxy class used to add and manipulate cubes
CubeProxyBaseBase class for CubeProxy
CullableAn interface that can be implemented in graphical entities to be able to use the view frustum culling services provided by the Octree
CylinderObjectClass representing the cylinder geometric primitive
CylinderProxyProxy class used to add and manipulate cylinders
CylinderProxyBaseBase class for CylinderProxy
DecoratorClass responsible for adding extra renderings effects and decorations to the scene rendered in the viewports
DefaultFactoryErrorDefault error policy for object factories
DelayedDispatchA wrapper class that enables optional status tracking of operations
DeleteWidgetDelete a widget, removing it from it's parent if any
DepthTestControls the depth test operation
DeserializationInterfaceAn interface for reading binary data independent of their byte order. It's independent of the underlying data source
DOFAn interface for providing a robot with a degree of freedom, in a way that's convinient to work with for the the users of both the server and proxy library
DOFProxyProxy class used to add and manipulate spheres
DOFProxyBaseBase class for DOFProxy
FactoryA generic and flexible object factory implementation
FrameClass representing a frame in the GUI
FrameCollectorProvides an interface enabling third parties to retrieve the resulting frame of a render pass
FrameSelectorClass representing a workspace, specifying a frame layout
GenericResultAn action result class that can be used to transmit basic peekabot types
GetChildrenThis action fetches the orientation of an object and returns it to the source proxy - it is not intended for usage by components other than the proxy
GetOrientationThis action fetches the orientation of an object and returns it to the source proxy - it is not intended for usage by components other than the proxy
GetPositionThis action fetches the position of an object and returns it to the source proxy - it is not intended for usage by components other than the proxy
GetTransformationThis action fetches the transformation of an object and returns it to the source proxy - it is not intended for usage by components other than the proxy
GridObjectA grid object
GridProxyProxy class used to add and manipulate grids
GridProxyBaseBase class for GridProxy
GroupObjectClass representing a group of other objects
GroupProxyProxy class used to add and manipulate groups
GroupProxyBaseBase class for GroupProxy
GUIUpdaterThe class is responsible for maintaining a queue of actions to update GUI widgets
IDAllocatorGeneric ID allocator interface
IDTranslatorTranslates IDs into SceneNode, SceneEntity and Cullable pointers
JointDOFA rotational joint DOF
LabelA text label primitives, for showing orientable, scalable labels
LabelProxyProxy class used to add and manipulate orientable text labels
LabelProxyBaseBase class for LabelProxy
LightModelA statelet that toggles two-sided lighting
LineBasedAn abstraction of objects in the scene that are scalable
LineBasedProxyProxy class usable with any type of object that is line-based
LineBasedProxyBaseBase class for all proxies to line-based objects
LineCloudPrimitive for efficient representation of line clouds
LineCloudProxyProxy class used to add and manipulate line clouds
LineCloudProxyBaseBase class for LineCloudProxy
LineParamsControls the parameters governing line appearance - line width and stipple pattern
LogA class for logging messages to file
MainMenuClass representing the main menu bar
MainWindowClass representing the main application window
MaterialControls all material properties except diffuse color, e.g. shininess and specular reflectance
MeshMesh superclass for indexed and unindexed geometry
MeshTransformerAn utility that takes a Mesh and transforms its data (currently geometry only) by the specified matrix
MessageA message class used to pass around information that's to be shown to the user or logged. Typically carries error or information messages
MessageFormatterAn interface providing methods for formatting messages, i.e. turning a Message object into a string
MessageHubA facility for subscribing to and publishing messages of various types - debug and client messages, for example
ModelObjectClass representing externally modeled objects in the scene
ModelProxyProxy class used to add and manipulate models
ModelProxyBaseBase class for ModelProxy
MonitorReportContains the outcome of an action executed in the server, which is then reported to back to the source proxy
MoveRotateGroupA group of properties and controls for moving and rotating objects
NameControls the name (as in glLoadName) used when rendering
NameGroupA group of properties and controls for setting name and meta name properties
NameTriggerTrigger for updating the name fields in aNameGroup
NoOpAn action that does absolutely nothing
NormalPointerControls which buffer is used to source normal data to OpenGL rendering commands (e.g. glDrawElements)
ObjectProxyProxy class used to manipulate any type of (remote) objects in the peekabot server
ObjectProxyBaseBase class for all client object proxies
ObjectVisitorInterface for visitors of SceneObject derived classes
OccupancyGrid2DProxyProxy class used to add and manipulate 2D occupancy grids
OccupancyGrid2DProxyBaseBase class for OccupancyGrid2DProxy
OctreeA loose octree implementation
Octree::OctreeNodeA node in the octree
OctreeTraverserInterface class used for traversing an Octree
OpacityThe type used to describe opacity for objects throughout the application
OperationResultProvides internal storage for and interaction with results
OperationStatusProvides storage for and interaction with operation statuses, for internal purposes. Provides a thread-safe interface for setting and getting a status, as well as inquiring about its availability
OptionA configuration option. Has a distinct type and can store a value of that type
PathIdentifierPathIdentifier is an auxillary class that provides a single interface for referring to objects in the scene tree, independent of whether the underlying identifier is an ObjectID, a path or a mixture of a path and an object ID
PeekabotClientEncapsulates a connection to a peekabot server
PeekabotProxyBaseBase class for all client proxies
PointCloudPrimitive for efficient representation of point clouds
PointCloudProxyProxy class used to add and manipulate point clouds
PointCloudProxyBaseBase class for PointCloudProxy
PointParamsGoverns the size of rendered points
PointSetObjectClass representing cameras in the scene
PolygonModeControls the fill mode (polygon mode) used when rendering
PolygonProxyProxy class used to add and manipulate polygons
PolygonProxyBaseBase class for PolygonProxy
PolyLineObjectClass representing the polyline geometric primitive
PrintfFormatterA MessageFormatter providing flexible formatting options similar in form and function to what's provided by C's printf function
PropertyFrameRepresents property inspector frames
PropertyGroupInterface for property groups
PropertyVisitorVisitor for extracting subclass-specific properties from SceneObject-derived classes
RangefinderA sensor data interpreter class for laser rangefinders
RemoveCameraRemoves an item from the camera menu of a ViewFrame widget
RenderableAn interface class to be implemented by anything that's renderable
RenderEngineA self-contained scene and rendering environment
RendererProvides a public interface to an encapsulated rendering engine
RendererRelayTraps graphical changes to the scene and forwards the information to the renderer
ResourceLoaderResource loader inteface
ResultEncapsulates a result from an operation, such as getting an object's color, executed remotely on the server
RGBColorA dumb RGB color struct
RobotObjectA SceneObject subtype that models robots
RobotProxyProxy class used to add and manipulate robots
RobotProxyBaseBase class for RobotProxy
RouterObserver
ScalableObjectAn abstraction of objects in the scene that are scalable
ScalableProxyProxy class used to manipulate any type of scalable object
ScalableProxyBaseBase class for all scalable object proxies
ScaleGroupA group controls for scaling objects uniformly or along specific axes
ScaleTriggerTrigger for updating the scale fields in aScaleGroup
SceneActionCommand pattern interface for making changes to the scene
SceneNodeA node in the scene
SceneObjectThe base object class
SceneObject::AccessDeniedAccess to object denied
SceneTree
SceneTree::TranslationTableAdd a translation rule
ScopedHandlerXML input handler class that organizes handler methods by scopes corresponding to the hierarchical levels in the XML document
ScopedHandler::TagScopeHolds the cdata and tag handlers that are valid within the current scope
ScopedMapMap for storing dynamic variables of arbitrary type, whose value can be overridden in local scopes
SectionModels a configuration section
SensorRepresents a sensor data interpreter for a specific type of sensor
SensorObjectClass representing robot sensors
SensorProxyProxy class used to manipulate sensors, and update their sensor readings, in particular
SensorProxyBaseBase class for SensorProxy
SerializationInterfaceAn interface for writing binary data in a format compatible with DeserializationBuffer. It's independent of the underlying data source
ServerConnectionModels the physical connection to the peekabot server
SetDOFValueSet the value of the given DOF
SetOccupancyGrid2DCellsThis action is used to set the coordinates of a object
SetOrientationSet the orientation of an object
SetPoseAn action that merges the procedure for setting an object's position and orientation into one easy to use package
SetPositionSets the position of an object without affecting its orientation
SetTransformationSet the model to parent transformation of an object, i.e. set its coordinate system
SetVerticesAction used to set or add coordinates of a vertex-based object
SourceIDDescribes the id and type of an Action generator
SphereObjectClass representing the sphere geometric primitive
SphereProxyProxy class used to add and manipulate spheres
SphereProxyBaseBase class for SphereProxy
StateletA statelet encapsulates a small part of an OpenGL rendering state, e.g. whether lighting is turning on, or the active stencil function
StateletImplThe interface for the implementation classes realizing the functionality of Statelets
StatusProvides a thread-safe way for surveying the outcome, henceforth referred to as status, of one operation (action)
StatusBarClass representing the status bar widget
StencilFuncControls the active stencil function
SubscriberAn interface that can be implemented to gain message recieving capability, as in messages published by a MessageHub
SyncTriggerA trigger responsible for ensuring that all auxillary data structures are up to date prior to rendering
TexCoordPointerControls which buffer is used to source UV-coordinates to OpenGL rendering commands (e.g. glDrawElements)
Texture2DClass that handles storage and binding of textures
ToolButtonBase class for Toolbar buttons
TrackDOFA linear displacement DOF
TreeBrowserTree widget for browsing the scene tree
TypedStateletThis extension to the Statelet class provides a type identifier that uniquely identifies its type (as in class)
UnauthenticatedStateThe state handler for unauthenticated connections
UpdateButtonUpdate action for toggle buttons
UpdateCameraAdds or updates an item in the camera menu of a ViewFrame widget
UpdateColorUpdate action for Fl_Color_Chooser widgets
UpdateInputUpdate action for text field widgets
UpdateValuatorUpdate value action for valuators
UpdateValuatorDomainUpdate domain action for valuators
UserInterfaceProvides an interface to the GUI for outside modules
UserInterfaceUtilitiesProvides some general utility functions for GUI classes
UserInterfaceUtilities::DeselectObjectGUI update action for deselecting deleted objects
Vector2A two dimensional vector class
Vector4A four dimensional vector class
VertexBasedProxyProxy class usable with any type of object that is vertex-based
VertexBasedProxyBaseBase class for all proxies to vertex-based objects
VertexBasedProxyBase::VertexSetA set of vertices, that's used to pass vertices to vertex-based object proxies
VertexPointerControls which buffer is used to source vertex data to OpenGL rendering commands (e.g. glDrawElements)
ViewFrameRepresents view frames
ViewportA graphical OpenGL area
VisibilityGroupA group of properties and controls for setting visibility properties
VisibilityTriggerTrigger for updating the visibility fields in aVisibilityGroup
XercesParserAn implementation of the XMLParser interface using the Xerces-C++ library
XMLHandlerBase class for handling SAX2 XML parsing events
XMLParserInterface for SAX2 XML parsers