Carna Registration API Version 1.16.0
Public Slots | Signals | Public Member Functions
CRA::Tool Class Reference

Represents a trackable tool. More...

#include <Tool.h>

Inheritance diagram for CRA::Tool:

List of all members.

Public Slots

void setName (const std::string &name)
 Renames this tool.
void setName (const QString &name)
 Renames this tool.
void setOffset (const Vector &offset)
 Sets an offset of this tool's origin in it's local coordinate system.

Signals

void renamed ()
 This tool has been renamed.
void renamed (const std::string &newName)
 This tool has been renamed.
void renamed (const QString &newName)
 This tool has been renamed.
void offsetChanged ()
 Emitted after the offset of this tool's origin in it's local coordinate system has changed.
void offsetChanged (const Vector &offset)
 Emitted after the offset of this tool's origin in it's local coordinate system has changed.

Public Member Functions

 Tool (const std::string &name)
 Creates a new tool.
const std::string & getName () const
 Tells this tool's name.
const Vector & getOffset () const
 Tells the offset of this tool's origin in it's local coordinate system.
virtual const Transformation & getOrientation () const =0
 Tells the current bearing of this tool.
virtual void computeRelativeOrientation (const Tool &reference, Transformation &out) const
 Computes the relative bearing of this tool to another.
virtual bool isVisible () const =0
 Tells whether this tool is currently visible.

Detailed Description

Represents a trackable tool.

Every tool has a name. The choice of a certain name has no further impact.

Author:
Leonid Kostrykin
Date:
23.3.12 - 22.2.13

Definition at line 36 of file Tool.h.


Member Function Documentation

const Vector& CRA::Tool::getOffset ( ) const

Tells the offset of this tool's origin in it's local coordinate system.

Since:
1.5
See also:
setOffset, getOrientation
virtual const Transformation& CRA::Tool::getOrientation ( ) const [pure virtual]

Tells the current bearing of this tool.

The result reflects the currently set offset.

Implemented in CRA::ToolByPort.

void CRA::Tool::offsetChanged ( const Vector &  offset) [signal]

Emitted after the offset of this tool's origin in it's local coordinate system has changed.

Since:
1.5
void CRA::Tool::offsetChanged ( ) [signal]

Emitted after the offset of this tool's origin in it's local coordinate system has changed.

Since:
1.5
void CRA::Tool::renamed ( const QString &  newName) [signal]

This tool has been renamed.

Since:
1.5
void CRA::Tool::setName ( const QString &  name) [slot]

Renames this tool.

Since:
1.5
void CRA::Tool::setOffset ( const Vector &  offset) [slot]

Sets an offset of this tool's origin in it's local coordinate system.

Since:
1.5
See also:
getOffset, getOrientation

The documentation for this class was generated from the following file:
 All Classes Functions Variables Enumerations Enumerator