Class LockedSubhinge

Class LockedSubhinge#

Inheritance Relationships#

Base Type#

Class Documentation#

class LockedSubhinge : public Karana::Dynamics::PhysicalSubhinge_T<0, 0>#

Represents a locked subhinge.

See Subhinges section for more information on physical subhinges.

Public Functions

LockedSubhinge(const kc::ks_ptr<kf::Frame> &oframe, const kc::ks_ptr<kf::Frame> &pframe, std::string_view name, const kc::ks_ptr<FramePairHinge> &hge)#

Constructs a LockedSubhinge.

Parameters:

  • oframe – the oframe frame

  • pframe – the pframe frame

  • name – the name for the subhinge

  • hge – the parent hinge

virtual ~LockedSubhinge()#

LockedSubhinge destructor.

virtual SubhingeType subhingeType() const override#

Helper method to return the subhinge type.

Returns:

the subhinge type

virtual void setParams(const kc::ks_ptr<PhysicalSubhingeParams> &params) override#

Set the parameters for this subhinge.

Parameters:

params – The parameters to set for this subhinge.

virtual kc::ks_ptr<PhysicalSubhingeParams> getParams() const override#

Get the parameters for this subhinge.

Returns:

The parameters to set for this subhinge.

Protected Functions

virtual kc::ks_ptr<PhysicalSubhinge::PhysicalSubhingeParamsAndState> _getParamsAndState() const override#

Get params for the subhinge.

Returns:

the params

virtual void _setParamsAndState(const PhysicalSubhinge::PhysicalSubhingeParamsAndState &params) override#

Apply the params from the twin subhinge to this subhinge.

Parameters:

params – the input parameters

Contents