Ignition Physics

API Reference

2.3.0

This class defines the concept of a Feature. It should be inherited by classes that define some plugin feature. More...

#include <Feature.hh>

Classes

class  Engine
 Placeholder class for the Engine API. Every Engine feature MUST inherit this class. More...
 
class  Implementation
 
class  Joint
 Placeholder class in case a Feature does not define its own Joint API. More...
 
class  Link
 Placeholder class in case a Feature does not define its own Link API. More...
 
class  Model
 Placeholder class in case a Feature does not define its own Model API. More...
 
class  Shape
 Placeholder class in case a Feature does not define its own Shape API. More...
 
class  World
 Placeholder class in case a Feature does not define its own World API. More...
 

Public Types

using RequiredFeatures = void
 By default, a blank feature will not require any other features. If your feature does require some other set of features, then you should inherit the FeatureWithRequirements class, and provide it with a list of the Features that you require. More...
 

Static Public Member Functions

template<typename SomeFeatureList , bool = false>
static constexpr bool ConflictsWith ()
 By default, a blank feature will not conflict with any other features. If your feature does conflict with some other set of features, then you should inherit the FeatureWithConflicts<...> class, and provide it a list of those conflicting features. More...
 

Detailed Description

This class defines the concept of a Feature. It should be inherited by classes that define some plugin feature.

Member Typedef Documentation

◆ RequiredFeatures

using RequiredFeatures = void

By default, a blank feature will not require any other features. If your feature does require some other set of features, then you should inherit the FeatureWithRequirements class, and provide it with a list of the Features that you require.

Member Function Documentation

◆ ConflictsWith()

static constexpr bool ConflictsWith ( )
inlinestatic

By default, a blank feature will not conflict with any other features. If your feature does conflict with some other set of features, then you should inherit the FeatureWithConflicts<...> class, and provide it a list of those conflicting features.


The documentation for this class was generated from the following file: