Class FramePairHingeVars

• Defined in File FramePairHinge.h

Inheritance Relationships

Base Type

• public Karana::Frame::OrientedChainedFrameToFrameVars (Class OrientedChainedFrameToFrameVars)

Class Documentation

class FramePairHingeVars : public Karana::Frame::OrientedChainedFrameToFrameVars

The Vars for the FramePairHinge class.

Public Functions

FramePairHingeVars(const kc::ks_ptr<FramePairHinge> &hge)

FramePairHingeVars constructor. The constructor is not meant to be called directly. Please use the create(…) method instead to create an instance.

Parameters:

hge – The hinge associated with this FramePairHingeVars.

~FramePairHingeVars()

Destructor.

virtual kc::NestedVars getAllVars() const override

Get all the Vars that this VarHolder has.

Returns:

A map of Vars, where the Var name is the key and the Var is the value.

Public Members

kc::ks_ptr<Karana::Core::Var_T<std::string>> hinge_type

The hinge type.

kc::ks_ptr<Karana::Core::Var_T<int>> n_subhinges

The number of subhinges.

kc::ks_ptr<Karana::Core::Var_T<int>> nQ

The number of Q coordinates.

kc::ks_ptr<Karana::Core::Var_T<int>> nU

The number of U coordinates.

Public Static Functions

static kc::ks_ptr<FramePairHingeVars> create(const kc::ks_ptr<FramePairHinge> &hge)

Create an instance of the FramePairHingeVars.

Parameters:

hge – The hinge associated with this FramePairHingeVars.

Returns:

A pointer to the newly created instance of FramePairHingeVars.