File: Concepts.Capabilities.txt

package info (click to toggle)
openni 1.5.4.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 44,844 kB
  • sloc: cpp: 116,706; ansic: 58,777; sh: 10,287; cs: 7,698; java: 7,402; python: 1,541; makefile: 492; xml: 167
file content (21 lines) | stat: -rw-r--r-- 1,411 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/**
@page conc_capabilities Capabilities Mechanism

OpenNI defines core functionality which is always supported by all node implementations of a specific node
type. Additional optional functionality is also defined by OpenNI and exposed as "capabilities".
The @ref xn::ProductionNode class provides the @ref xn::ProductionNode::IsCapabilitySupported "IsCapabilitySupported()" 
method to check if this specific implementation supports a certain capability.

In summary, there are two separate functionality sets: 
- Obligatory functionality that is accessible through the methods provided by the principle OpenNI 
  production node classes, i.e., the @ref xn::ProductionNode "ProductionNode" class and its derivatives. 
  Developers wishing to implement their own nodes are obliged to implement these functionalities
  (events, methods, etc.) 
- Optional functionality that is accessible through the capabilities mechanism. The developers can 
  optionally implement these classes and their members. The capability's functionality is then accessible 
  through the capability's name. OpenNI supports a defined list of optional capabilities. 

An example of a capability is the @ref xn::MirrorCapability "MirrorCapability" class. When this capability is 
supported by any particular production node, the application can call its 
@ref xn::MirrorCapability::SetMirror() "SetMirror()" method.
*/