ScriptInterface::Constraints::ShapeBasedConstraint Class Reference

#include <ShapeBasedConstraint.hpp>

Inheritance diagram for ScriptInterface::Constraints::ShapeBasedConstraint:

Collaboration diagram for ScriptInterface::Constraints::ShapeBasedConstraint:

Public Member Functions
	ShapeBasedConstraint ()
Variant	do_call_method (std::string const &name, VariantMap const &) override
std::shared_ptr<::Constraints::Constraint >	constraint () override
std::shared_ptr< const ::Constraints::Constraint >	constraint () const override
std::shared_ptr<::Constraints::ShapeBasedConstraint >	shape_based_constraint () const
void	do_construct (VariantMap const &params) override
void	bind_system (std::shared_ptr<::System::System const > const &system) override
Public Member Functions inherited from ScriptInterface::AutoParameters< Constraint >
std::span< const boost::string_ref >	valid_parameters () const final
Variant	get_parameter (const std::string &name) const final
void	do_set_parameter (const std::string &name, const Variant &value) final
std::vector< std::pair< std::string, Variant > >	serialize_parameters () const final
Public Member Functions inherited from ScriptInterface::ObjectHandle
	ObjectHandle ()=default
	ObjectHandle (ObjectHandle const &)=delete
ObjectHandle &	operator= (ObjectHandle const &)=delete
virtual	~ObjectHandle ()=default
boost::string_ref	name () const
Context *	context () const
	Responsible context.
void	construct (VariantMap const &params)
	Construct the handled object.
VariantMap	get_parameters () const
	Get current parameters.
auto	get_valid_parameters () const
void	set_parameter (const std::string &name, const Variant &value)
	Set single parameter.
Variant	call_method (const std::string &name, const VariantMap &params)
	Call a method on the object.
std::string	serialize () const

Additional Inherited Members
Static Public Member Functions inherited from ScriptInterface::ObjectHandle
static ObjectRef	deserialize (const std::string &state, Context &ctx)
	Make object from serialized state.
Protected Member Functions inherited from ScriptInterface::AutoParameters< Constraint >
	AutoParameters ()=default
	AutoParameters (std::vector< AutoParameter > &&params)
void	add_parameters (std::vector< AutoParameter > &&params)
auto const &	get_parameter_insertion_order () const

Detailed Description

Definition at line 40 of file script_interface/constraints/ShapeBasedConstraint.hpp.

Constructor & Destructor Documentation

ShapeBasedConstraint()

ScriptInterface::Constraints::ShapeBasedConstraint::ShapeBasedConstraint ( )

inline

Definition at line 45 of file script_interface/constraints/ShapeBasedConstraint.hpp.

References ScriptInterface::AutoParameters< Constraint >::add_parameters(), System::get_system(), and ScriptInterface::get_value().

Member Function Documentation

bind_system()

void ScriptInterface::Constraints::ShapeBasedConstraint::bind_system ( std::shared_ptr<::System::System const > const &  system )

inlineoverridevirtual

Reimplemented from ScriptInterface::Constraints::Constraint.

Definition at line 106 of file script_interface/constraints/ShapeBasedConstraint.hpp.

References ScriptInterface::AutoParameters< Constraint >::do_set_parameter(), ScriptInterface::get_value(), and shape_based_constraint().

constraint() [1/2]

std::shared_ptr< const ::Constraints::Constraint > ScriptInterface::Constraints::ShapeBasedConstraint::constraint ( ) const

inlineoverridevirtual

Implements ScriptInterface::Constraints::Constraint.

Definition at line 90 of file script_interface/constraints/ShapeBasedConstraint.hpp.

constraint() [2/2]

std::shared_ptr<::Constraints::Constraint > ScriptInterface::Constraints::ShapeBasedConstraint::constraint ( )

inlineoverridevirtual

Implements ScriptInterface::Constraints::Constraint.

Definition at line 87 of file script_interface/constraints/ShapeBasedConstraint.hpp.

do_call_method()

Variant ScriptInterface::Constraints::ShapeBasedConstraint::do_call_method ( std::string const &  name, VariantMap const &    )

inlineoverridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 70 of file script_interface/constraints/ShapeBasedConstraint.hpp.

References ScriptInterface::get_value(), ScriptInterface::ObjectHandle::name(), ScriptInterface::none, and shape_based_constraint().

do_construct()

void ScriptInterface::Constraints::ShapeBasedConstraint::do_construct ( VariantMap const &  params )

inlineoverridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 98 of file script_interface/constraints/ShapeBasedConstraint.hpp.

References ScriptInterface::AutoParameters< Constraint >::do_set_parameter(), and params.

shape_based_constraint()

std::shared_ptr<::Constraints::ShapeBasedConstraint > ScriptInterface::Constraints::ShapeBasedConstraint::shape_based_constraint ( ) const

inline

Definition at line 94 of file script_interface/constraints/ShapeBasedConstraint.hpp.

Referenced by bind_system(), and do_call_method().

---

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

• script_interface/constraints/ShapeBasedConstraint.hpp