Metahuman_DNA_Calibration/docs/doxygen/build/xml/classdnac_1_1TranslateCommand.xml

300 lines
19 KiB
XML
Raw Normal View History

2022-11-28 19:21:26 +08:00
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.4" xml:lang="en-US">
<compounddef id="classdnac_1_1TranslateCommand" kind="class" language="C++" prot="public">
<compoundname>dnac::TranslateCommand</compoundname>
<basecompoundref refid="classdnac_1_1Command" prot="public" virt="non-virtual">dnac::Command</basecompoundref>
<includes refid="TranslateCommand_8h" local="no">TranslateCommand.h</includes>
<innerclass refid="classdnac_1_1TranslateCommand_1_1Impl" prot="public">dnac::TranslateCommand::Impl</innerclass>
<sectiondef kind="private-attrib">
<memberdef kind="variable" id="classdnac_1_1TranslateCommand_1ac9e14edbdc7ce9cd9303c2582e89eb6f" prot="private" static="no" mutable="no">
<type><ref refid="classpma_1_1ScopedPtr" kindref="compound">ScopedPtr</ref>&lt; <ref refid="classdnac_1_1TranslateCommand_1_1Impl" kindref="compound">Impl</ref> &gt;</type>
<definition>ScopedPtr&lt;Impl&gt; dnac::TranslateCommand::pImpl</definition>
<argsstring></argsstring>
<name>pImpl</name>
<qualifiedname>dnac::TranslateCommand::pImpl</qualifiedname>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
2022-12-02 21:35:01 +08:00
<location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" line="41" column="19" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" bodystart="41" bodyend="-1"/>
2022-11-28 19:21:26 +08:00
<referencedby refid="classdnac_1_1TranslateCommand_1ad0d58b5f3b6787a7105b6f851c95dcbf" compoundref="TranslateCommand_8cpp" startline="83" endline="85">run</referencedby>
<referencedby refid="classdnac_1_1TranslateCommand_1adcb40bea634cd18b0ead09a02d556301" compoundref="TranslateCommand_8cpp" startline="79" endline="81">setTranslation</referencedby>
<referencedby refid="classdnac_1_1TranslateCommand_1a7ba040a53fbe8497515804f1b54e24e5" compoundref="TranslateCommand_8cpp" startline="69" endline="73">TranslateCommand</referencedby>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
<memberdef kind="function" id="classdnac_1_1TranslateCommand_1ac1d785e5ab6e279bc5621f295bb659d3" prot="public" static="no" const="no" explicit="yes" inline="no" virt="non-virtual">
<type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref></type>
<definition>dnac::TranslateCommand::TranslateCommand</definition>
<argsstring>(MemoryResource *memRes=nullptr)</argsstring>
<name>TranslateCommand</name>
<qualifiedname>dnac::TranslateCommand::TranslateCommand</qualifiedname>
<param>
<type><ref refid="classpma_1_1MemoryResource" kindref="compound">MemoryResource</ref> *</type>
<declname>memRes</declname>
<defval>nullptr</defval>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
2022-12-02 21:35:01 +08:00
<location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" line="20" column="26" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/src/dnacalib/commands/TranslateCommand.cpp" bodystart="66" bodyend="67"/>
2022-11-28 19:21:26 +08:00
</memberdef>
<memberdef kind="function" id="classdnac_1_1TranslateCommand_1a7ba040a53fbe8497515804f1b54e24e5" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref></type>
<definition>dnac::TranslateCommand::TranslateCommand</definition>
<argsstring>(Vector3 translation, MemoryResource *memRes=nullptr)</argsstring>
<name>TranslateCommand</name>
<qualifiedname>dnac::TranslateCommand::TranslateCommand</qualifiedname>
<param>
<type><ref refid="structdna_1_1Vector3" kindref="compound">Vector3</ref></type>
<declname>translation</declname>
</param>
<param>
<type><ref refid="classpma_1_1MemoryResource" kindref="compound">MemoryResource</ref> *</type>
<declname>memRes</declname>
<defval>nullptr</defval>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
2022-12-02 21:35:01 +08:00
<location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" line="21" column="17" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/src/dnacalib/commands/TranslateCommand.cpp" bodystart="69" bodyend="73"/>
2022-11-28 19:21:26 +08:00
<references refid="classdnac_1_1TranslateCommand_1ac9e14edbdc7ce9cd9303c2582e89eb6f" compoundref="TranslateCommand_8h" startline="41">pImpl</references>
</memberdef>
<memberdef kind="function" id="classdnac_1_1TranslateCommand_1a3de26bdddc1ef58f54ee8c7ae81d8acd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref></type>
<definition>dnac::TranslateCommand::~TranslateCommand</definition>
<argsstring>()</argsstring>
<name>~TranslateCommand</name>
<qualifiedname>dnac::TranslateCommand::~TranslateCommand</qualifiedname>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
2022-12-02 21:35:01 +08:00
<location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" line="23" column="17"/>
2022-11-28 19:21:26 +08:00
</memberdef>
<memberdef kind="function" id="classdnac_1_1TranslateCommand_1a0a23b793a297161586e354a4319d53d1" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>dnac::TranslateCommand::TranslateCommand</definition>
<argsstring>(const TranslateCommand &amp;)=delete</argsstring>
<name>TranslateCommand</name>
<qualifiedname>dnac::TranslateCommand::TranslateCommand</qualifiedname>
<param>
<type>const <ref refid="classdnac_1_1TranslateCommand" kindref="compound">TranslateCommand</ref> &amp;</type>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
2022-12-02 21:35:01 +08:00
<location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" line="25" column="9"/>
2022-11-28 19:21:26 +08:00
</memberdef>
<memberdef kind="function" id="classdnac_1_1TranslateCommand_1aa92ba5393d5bcb1f083e6b83a0b03cb2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classdnac_1_1TranslateCommand" kindref="compound">TranslateCommand</ref> &amp;</type>
<definition>TranslateCommand &amp; dnac::TranslateCommand::operator=</definition>
<argsstring>(const TranslateCommand &amp;)=delete</argsstring>
<name>operator=</name>
<qualifiedname>dnac::TranslateCommand::operator=</qualifiedname>
<param>
<type>const <ref refid="classdnac_1_1TranslateCommand" kindref="compound">TranslateCommand</ref> &amp;</type>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
2022-12-02 21:35:01 +08:00
<location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" line="26" column="26"/>
2022-11-28 19:21:26 +08:00
</memberdef>
<memberdef kind="function" id="classdnac_1_1TranslateCommand_1ae0282eb3d737e21691d90c96e9480394" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref></type>
<definition>dnac::TranslateCommand::TranslateCommand</definition>
<argsstring>(TranslateCommand &amp;&amp;)</argsstring>
<name>TranslateCommand</name>
<qualifiedname>dnac::TranslateCommand::TranslateCommand</qualifiedname>
<param>
<type><ref refid="classdnac_1_1TranslateCommand" kindref="compound">TranslateCommand</ref> &amp;&amp;</type>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
2022-12-02 21:35:01 +08:00
<location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" line="28" column="17"/>
2022-11-28 19:21:26 +08:00
</memberdef>
<memberdef kind="function" id="classdnac_1_1TranslateCommand_1aafe6799b47f756b1a3c1e50bd71d4b86" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref> <ref refid="classdnac_1_1TranslateCommand" kindref="compound">TranslateCommand</ref> &amp;</type>
<definition>TranslateCommand &amp; dnac::TranslateCommand::operator=</definition>
<argsstring>(TranslateCommand &amp;&amp;)</argsstring>
<name>operator=</name>
<qualifiedname>dnac::TranslateCommand::operator=</qualifiedname>
<param>
<type><ref refid="classdnac_1_1TranslateCommand" kindref="compound">TranslateCommand</ref> &amp;&amp;</type>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
2022-12-02 21:35:01 +08:00
<location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" line="29" column="34"/>
2022-11-28 19:21:26 +08:00
</memberdef>
<memberdef kind="function" id="classdnac_1_1TranslateCommand_1adcb40bea634cd18b0ead09a02d556301" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref> void</type>
<definition>void dnac::TranslateCommand::setTranslation</definition>
<argsstring>(Vector3 translation)</argsstring>
<name>setTranslation</name>
<qualifiedname>dnac::TranslateCommand::setTranslation</qualifiedname>
<param>
<type><ref refid="structdna_1_1Vector3" kindref="compound">Vector3</ref></type>
<declname>translation</declname>
</param>
<briefdescription>
<para>Method for setting the translation vector. </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>translation</parametername>
</parameternamelist>
<parameterdescription>
<para>The translation vector. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
2022-12-02 21:35:01 +08:00
<location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" line="36" column="22" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/src/dnacalib/commands/TranslateCommand.cpp" bodystart="79" bodyend="81"/>
2022-11-28 19:21:26 +08:00
<references refid="classdnac_1_1TranslateCommand_1ac9e14edbdc7ce9cd9303c2582e89eb6f" compoundref="TranslateCommand_8h" startline="41">pImpl</references>
</memberdef>
<memberdef kind="function" id="classdnac_1_1TranslateCommand_1ad0d58b5f3b6787a7105b6f851c95dcbf" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
<type><ref refid="dnacalib_2Defs_8h_1a582ed0de52e12122ce3c978581df8113" kindref="member">DNACAPI</ref> void</type>
<definition>void dnac::TranslateCommand::run</definition>
<argsstring>(DNACalibDNAReader *output) override</argsstring>
<name>run</name>
<qualifiedname>dnac::TranslateCommand::run</qualifiedname>
<reimplements refid="classdnac_1_1Command_1a204ca2536a334f4eb83c66e09ef3ecee">run</reimplements>
<param>
<type><ref refid="classdnac_1_1DNACalibDNAReader" kindref="compound">DNACalibDNAReader</ref> *</type>
<declname>output</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
2022-12-02 21:35:01 +08:00
<location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" line="37" column="22" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/src/dnacalib/commands/TranslateCommand.cpp" bodystart="83" bodyend="85"/>
2022-11-28 19:21:26 +08:00
<references refid="classdnac_1_1TranslateCommand_1ac9e14edbdc7ce9cd9303c2582e89eb6f" compoundref="TranslateCommand_8h" startline="41">pImpl</references>
</memberdef>
</sectiondef>
<briefdescription>
<para><ref refid="classdnac_1_1TranslateCommand" kindref="compound">TranslateCommand</ref> is used to translate neutral joints and vertex positions. </para>
</briefdescription>
<detaileddescription>
<para><simplesect kind="note"><para>Joint translations are represented in parent space, so it is enough to translate only root joints, as that translation will be propagated to the rest of the joints. </para>
</simplesect>
</para>
</detaileddescription>
<inheritancegraph>
<node id="2">
<label>dnac::Command</label>
<link refid="classdnac_1_1Command"/>
</node>
<node id="1">
<label>dnac::TranslateCommand</label>
<link refid="classdnac_1_1TranslateCommand"/>
<childnode refid="2" relation="public-inheritance">
</childnode>
</node>
</inheritancegraph>
<collaborationgraph>
<node id="3">
<label>pma::ScopedPtr&lt; dnac::TranslateCommand::Impl &gt;</label>
<link refid="classpma_1_1ScopedPtr"/>
<childnode refid="4" relation="private-inheritance">
</childnode>
<childnode refid="5" relation="usage">
<edgelabel>-ptr</edgelabel>
</childnode>
<childnode refid="7" relation="template-instance">
<edgelabel>&lt; dnac::TranslateCommand::Impl &gt;</edgelabel>
</childnode>
</node>
<node id="2">
<label>dnac::Command</label>
<link refid="classdnac_1_1Command"/>
</node>
<node id="1">
<label>dnac::TranslateCommand</label>
<link refid="classdnac_1_1TranslateCommand"/>
<childnode refid="2" relation="public-inheritance">
</childnode>
<childnode refid="3" relation="usage">
<edgelabel>-pImpl</edgelabel>
</childnode>
</node>
<node id="9">
<label>pma::ScopedPtr&lt; T, TDestroyer &gt;::inspect&lt; T &gt;</label>
<link refid="structpma_1_1ScopedPtr_1_1inspect"/>
<childnode refid="6" relation="template-instance">
<edgelabel>&lt; T &gt;</edgelabel>
</childnode>
</node>
<node id="5">
<label>pma::ScopedPtr&lt; T, TDestroyer &gt;::inspect&lt; dnac::TranslateCommand::Impl &gt;</label>
<link refid="structpma_1_1ScopedPtr_1_1inspect"/>
<childnode refid="6" relation="template-instance">
<edgelabel>&lt; dnac::TranslateCommand::Impl &gt;</edgelabel>
</childnode>
</node>
<node id="7">
<label>pma::ScopedPtr&lt; T, TDestroyer &gt;</label>
<link refid="classpma_1_1ScopedPtr"/>
<childnode refid="8" relation="private-inheritance">
</childnode>
<childnode refid="9" relation="usage">
<edgelabel>-ptr</edgelabel>
</childnode>
</node>
<node id="6">
<label>pma::ScopedPtr&lt; T, TDestroyer &gt;::inspect&lt; U &gt;</label>
<link refid="structpma_1_1ScopedPtr_1_1inspect"/>
</node>
<node id="8">
<label>typename DefaultInstanceDestroyer&lt;T&gt;::type</label>
</node>
<node id="4">
<label>typename DefaultInstanceDestroyer&lt;dnac::TranslateCommand::Impl &gt;::type</label>
</node>
</collaborationgraph>
2022-12-02 21:35:01 +08:00
<location file="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" line="18" column="1" bodyfile="C:/source/MetaHuman-DNA-Calibration_clean/dnacalib/DNACalib/include/dnacalib/commands/TranslateCommand.h" bodystart="18" bodyend="43"/>
2022-11-28 19:21:26 +08:00
<listofallmembers>
<member refid="classdnac_1_1TranslateCommand_1aa92ba5393d5bcb1f083e6b83a0b03cb2" prot="public" virt="non-virtual"><scope>dnac::TranslateCommand</scope><name>operator=</name></member>
<member refid="classdnac_1_1TranslateCommand_1aafe6799b47f756b1a3c1e50bd71d4b86" prot="public" virt="non-virtual"><scope>dnac::TranslateCommand</scope><name>operator=</name></member>
<member refid="classdnac_1_1TranslateCommand_1ac9e14edbdc7ce9cd9303c2582e89eb6f" prot="private" virt="non-virtual"><scope>dnac::TranslateCommand</scope><name>pImpl</name></member>
<member refid="classdnac_1_1TranslateCommand_1ad0d58b5f3b6787a7105b6f851c95dcbf" prot="public" virt="virtual"><scope>dnac::TranslateCommand</scope><name>run</name></member>
<member refid="classdnac_1_1TranslateCommand_1adcb40bea634cd18b0ead09a02d556301" prot="public" virt="non-virtual"><scope>dnac::TranslateCommand</scope><name>setTranslation</name></member>
<member refid="classdnac_1_1TranslateCommand_1ac1d785e5ab6e279bc5621f295bb659d3" prot="public" virt="non-virtual"><scope>dnac::TranslateCommand</scope><name>TranslateCommand</name></member>
<member refid="classdnac_1_1TranslateCommand_1a7ba040a53fbe8497515804f1b54e24e5" prot="public" virt="non-virtual"><scope>dnac::TranslateCommand</scope><name>TranslateCommand</name></member>
<member refid="classdnac_1_1TranslateCommand_1a0a23b793a297161586e354a4319d53d1" prot="public" virt="non-virtual"><scope>dnac::TranslateCommand</scope><name>TranslateCommand</name></member>
<member refid="classdnac_1_1TranslateCommand_1ae0282eb3d737e21691d90c96e9480394" prot="public" virt="non-virtual"><scope>dnac::TranslateCommand</scope><name>TranslateCommand</name></member>
<member refid="classdnac_1_1Command_1a61be18c56cbef51019c8f7b1f752518c" prot="public" virt="virtual"><scope>dnac::TranslateCommand</scope><name>~Command</name></member>
<member refid="classdnac_1_1TranslateCommand_1a3de26bdddc1ef58f54ee8c7ae81d8acd" prot="public" virt="non-virtual"><scope>dnac::TranslateCommand</scope><name>~TranslateCommand</name></member>
</listofallmembers>
</compounddef>
</doxygen>