Program Listing for File OrientedChainedFrameToFrame.h

Program Listing for File OrientedChainedFrameToFrame.h#

Return to documentation for file (include/Karana/Frame/OrientedChainedFrameToFrame.h)

/*
*Copyright(c)2024-2025KaranaDynamicsPtyLtd.Allrightsreserved.
*
*NOTICETOUSER:
*
*Thissourcecodeand/ordocumentation(the"LicensedMaterials")is
*theconfidentialandproprietaryinformationofKaranaDynamicsInc.
*UseoftheseLicensedMaterialsisgovernedbythetermsandconditions
*ofaseparatesoftwarelicenseagreementbetweenKaranaDynamicsandthe
*Licensee("LicenseAgreement").Unlessexpresslypermittedunderthat
*agreement,anyreproduction,modification,distribution,ordisclosure
*oftheLicensedMaterials,inwholeorinpart,toanythirdparty
*withoutthepriorwrittenconsentofKaranaDynamicsisstrictlyprohibited.
*
*THELICENSEDMATERIALSAREPROVIDED"ASIS"WITHOUTWARRANTYOFANYKIND.
*KARANADYNAMICSDISCLAIMSALLWARRANTIES,EXPRESSORIMPLIED,INCLUDING
*BUTNOTLIMITEDTOWARRANTIESOFMERCHANTABILITY,NON-INFRINGEMENT,AND
*FITNESSFORAPARTICULARPURPOSE.
*
*INNOEVENTSHALLKARANADYNAMICSBELIABLEFORANYDAMAGESWHATSOEVER,
*INCLUDINGBUTNOTLIMITEDTOLOSSOFPROFITS,DATA,ORUSE,EVENIF
*ADVISEDOFTHEPOSSIBILITYOFSUCHDAMAGES,WHETHERINCONTRACT,TORT,
*OROTHERWISEARISINGOUTOFORINCONNECTIONWITHTHELICENSEDMATERIALS.
*
*U.S.GovernmentEndUsers:TheLicensedMaterialsarea"commercialitem"
*asdefinedat48C.F.R.2.101,andareprovidedtotheU.S.Government
*onlyasacommercialenditemunderthetermsofthislicense.
*
*AnyuseoftheLicensedMaterialsinindividualorcommercialsoftwaremust
*include,intheuserdocumentationandinternalsourcecodecomments,
*thisNotice,Disclaimer,andU.S.GovernmentUseProvision.
*/


#pragmaonce

#include"Karana/Frame/FrameToFrame.h"

namespaceKarana::Frame{

namespacekc=Karana::Core;
namespacekm=Karana::Math;

classChainedFrameToFrame;

classOrientedChainedFrameToFrame:publicFrameToFrame{
//ForaccesstoourDataCachemembers
friendChainedFrameToFrame;

//Foraccessto_empty
friendclassFrame;
friendclassFrameContainer;

public:
OrientedChainedFrameToFrame(constkc::ks_ptr<Frame>&oframe,
constkc::ks_ptr<Frame>&pframe,
std::string_viewname="");

staticconstkc::ks_ptr<OrientedChainedFrameToFrame>&
lookupOrCreate(constkc::ks_ptr<Frame>&oframe,constkc::ks_ptr<Frame>&pframe);

size_tnumEdges()const;

std::stringgetPath()const;

structDumpOptions:FrameToFrame::DumpOptions{

boolpath=true;

//Addingsuppression,asCodeCheckercomplainsthismethodhasthesamenameasa
//methodinthebaseversion.ThisisjustaCodeCheckerfalsepositive.
//codechecker_suppress[cppcheck-duplInheritedMember]
DumpOptions&operator=(constDumpOptions&p){
if(this!=&p){
FrameToFrame::DumpOptions::operator=(p);//Callbaseclassassignmentoperator
//AssignDerived-specificmembershere
path=p.path;
}

return*this;
}
};

std::stringdumpString(std::string_viewprefix="",
constBase::DumpOptions*options=nullptr)constoverride;

protected:
void_empty()override;

void_computeTransform(km::HomTran&T)override;

void_computeVelocity(km::SpatialVector&V)override;

void_computeAccel(km::SpatialVector&a)override;

void_makeCurrent()override;

void_makeStale()override;

void_setup();

void_discard(kc::ks_ptr<Base>&base)override;

kc::ks_ptr<Frame>_pframe_parent=nullptr;

kc::ks_ptr<EdgeFrameToFrame>_pframe_edge_f2f=nullptr;

kc::ks_ptr<OrientedChainedFrameToFrame>_to_parent_f2f=nullptr;
};
}//namespaceKarana::Frame