OSSIA
Open Scenario System for Interactive Application
opp Namespace Reference

Detailed Description

is the namespace for libossia's C++98 (SafeC++ bindings)

Classes

class  value
 The value class holds all ossia parameters typed values. More...
 
struct  callback_index
 The callback_index struct holds callbacks for adding listeners to parameters' values. More...
 
class  node
 The node class holds all ossia nodes and their std::optional parameters. More...
 
class  oscquery_server
 The oscquery_server class allows to create a local OSCQuery server. More...
 
class  oscquery_mirror
 The oscquery_mirror class allows to create a mirror image of a remote OSCQuery server. More...
 

Typedefs

typedef void(* value_callback) (void *, const opp::value &)
 container for a value callback More...
 
typedef void(* connection_callback) (void *, const std::string &)
 container for a connection callback More...
 
typedef void(* disconnection_callback) (void *, const std::string &)
 container for a disconnection callback More...
 
typedef void(* parameter_callback) (void *, const opp::node &)
 container for a parameter creation/deletion callback
 
typedef void(* node_callback) (void *, const opp::node &)
 container for a node creation/deletion callback
 
typedef void(* node_rn_callback) (void *, const opp::node &, std::string)
 container for a node renamed callback
 
typedef void(* message_callback) (void *, const opp::node &)
 container for a message callback
 
typedef void(* unhandled_message_callback) (void *, const std::string &, const opp::value &)
 container for an unhandled message callback
 
typedef void(* attribute_modified_callback) (void *, const opp::node &, const std::string &)
 container for an attribute modified callback
 
typedef bool(* rename_node_callback) (void *, const std::string &, const std::string &)
 container for a node rename request callback should return true if node could be renamed
 
typedef bool(* remove_node_callback) (void *, const std::string &)
 container for a node remove request callback should return true if node could be remove
 
typedef bool(* add_node_callback) (void *, const std::string &, const std::string &)
 container for a node creation request callback should return true if node could be created
 

Enumerations

enum  access_mode { Get , Set , Bi }
 Defines Write (Set), Read (Get) or Read/Write (Bi) access to the parameter's value. More...
 
enum  bounding_mode {
  Free , Clip , Wrap , Fold ,
  Low , High
}
 Behaviour at the bounds of the value. More...
 

Typedef Documentation

◆ value_callback

typedef void(* opp::value_callback) (void *, const opp::value &)

container for a value callback

See also
opp::callback_index
opp::node::set_value_callback

◆ connection_callback

typedef void(* opp::connection_callback) (void *, const std::string &)

container for a connection callback

See also
opp::osquery_server::set_connection_callback

◆ disconnection_callback

typedef void(* opp::disconnection_callback) (void *, const std::string &)

container for a disconnection callback

See also
opp::osquery_server::set_disconnection_callback

Enumeration Type Documentation

◆ access_mode

Defines Write (Set), Read (Get) or Read/Write (Bi) access to the parameter's value.

Access modes define if the parameter's value be accessed only on read, on write, or bidirectionnally

Enumerator
Get 

only read the value

Set 

only write the value

Bi 

read and write the value

◆ bounding_mode

Behaviour at the bounds of the value.

Bounding modes define what to do at the bounds of the parameter's value

Enumerator
Free 

Let the value go all the way both sides over the bounds

Clip 

Clip (clamp) the values at the bounds

Wrap 

Start over at min bound when going over max bound (and vice-versa)

Fold 

Fold back value when passing over the bound

Low 

Clip the values only on the min bound

High 

Clip the values only at the max bound