RcsPySim
A robot control and simulation library
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Rcs::PhysicsParameterDescriptor Class Referenceabstract

#include <PhysicsParameterDescriptor.h>

Inheritance diagram for Rcs::PhysicsParameterDescriptor:
Inheritance graph
[legend]
Collaboration diagram for Rcs::PhysicsParameterDescriptor:
Collaboration graph
[legend]

Public Member Functions

 PhysicsParameterDescriptor ()
 
virtual ~PhysicsParameterDescriptor ()
 
virtual void getValues (PropertySink *outValues)=0
 
virtual void setValues (PropertySource *inValues)=0
 

Protected Member Functions

virtual void init (BodyParamInfo *bodyParamInfo)
 

Protected Attributes

BodyParamInfo * bodyParamInfo
 

Friends

class PhysicsParameterManager
 
class PPDCompound
 

Detailed Description

Descriptor for one or more physical parameters settable from Python.

The parameters should be stored on the BodyParamInfo reference.

Definition at line 46 of file PhysicsParameterDescriptor.h.

Constructor & Destructor Documentation

◆ PhysicsParameterDescriptor()

Rcs::PhysicsParameterDescriptor::PhysicsParameterDescriptor ( )

Definition at line 36 of file PhysicsParameterDescriptor.cpp.

◆ ~PhysicsParameterDescriptor()

Rcs::PhysicsParameterDescriptor::~PhysicsParameterDescriptor ( )
virtualdefault

Member Function Documentation

◆ getValues()

virtual void Rcs::PhysicsParameterDescriptor::getValues ( PropertySink *  outValues)
pure virtual

Read values from graph and put them into the given dict.

Implemented in Rcs::PPDRodLength, Rcs::PPDCompound, Rcs::PPDSingleVar< T >, Rcs::PPDSingleVar< double >, and Rcs::PPDMaterialProperties.

◆ init()

void Rcs::PhysicsParameterDescriptor::init ( BodyParamInfo *  bodyParamInfo)
protectedvirtual

Setup descriptor to work on the given body reference. Override for more custom initialization.

Reimplemented in Rcs::PPDSingleVar< T >, Rcs::PPDSingleVar< double >, Rcs::PPDCubeExtents, Rcs::PPDSphereRadius, Rcs::PPDRodLength, Rcs::PPDBoxExtents, Rcs::PPDBodyOrientation, Rcs::PPDBodyPosition, and Rcs::PPDCompound.

Definition at line 43 of file PhysicsParameterDescriptor.cpp.

◆ setValues()

virtual void Rcs::PhysicsParameterDescriptor::setValues ( PropertySource *  inValues)
pure virtual

Read values from the given dict and apply them to the graph. The parameter names need to be the same as in Rcs, e.g. rolling_friction_coefficient.

Implemented in Rcs::PPDCubeExtents, Rcs::PPDRodLength, Rcs::PPDSingleVar< T >, Rcs::PPDSingleVar< double >, Rcs::PPDSphereRadius, Rcs::PPDCompound, Rcs::PPDMassProperties, Rcs::PPDMaterialProperties, Rcs::PPDBoxExtents, Rcs::PPDBodyOrientation, and Rcs::PPDBodyPosition.

Friends And Related Function Documentation

◆ PhysicsParameterManager

friend class PhysicsParameterManager
friend

Definition at line 69 of file PhysicsParameterDescriptor.h.

◆ PPDCompound

friend class PPDCompound
friend

Definition at line 71 of file PhysicsParameterDescriptor.h.

Member Data Documentation

◆ bodyParamInfo

BodyParamInfo* Rcs::PhysicsParameterDescriptor::bodyParamInfo
protected

Definition at line 50 of file PhysicsParameterDescriptor.h.

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