Class LockedOffsetSubhinge

Class LockedOffsetSubhinge#

Inheritance Relationships#

Base Type#

Class Documentation#

class LockedOffsetSubhinge : public Karana::Dynamics::LockedSubhinge#

Represents a locked subhinge with transform offset.

See Subhinges section for more information on physical subhinges.

Public Functions

LockedOffsetSubhinge(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 LockedOffsetSubhinge.

Parameters:

  • oframe – the oframe frame

  • pframe – the pframe frame

  • name – the name for the subhinge

  • hge – the parent hinge

virtual SubhingeType subhingeType() const override#

Helper method to return the subhinge type.

Returns:

the subhinge type

void setOffset(const km::HomTran &offset)#

Set the subhinge offset transform.

Parameters:

offset – the offset param.

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.

Contents