dnac::RemoveJointAnimationCommand Class Reference

RemoveJointAnimationCommand is used to remove joint animation data. More...

#include <RemoveJointAnimationCommand.h>

Inheritance diagram for dnac::RemoveJointAnimationCommand:

Collaboration diagram for dnac::RemoveJointAnimationCommand:

Classes
class	Impl

Public Member Functions
DNACAPI	RemoveJointAnimationCommand (MemoryResource *memRes=nullptr)
DNACAPI	RemoveJointAnimationCommand (std::uint16_t jointIndex, MemoryResource *memRes=nullptr)
DNACAPI	RemoveJointAnimationCommand (ConstArrayView< std::uint16_t > jointIndices, MemoryResource *memRes=nullptr)
DNACAPI	~RemoveJointAnimationCommand ()
	RemoveJointAnimationCommand (const RemoveJointAnimationCommand &)=delete
RemoveJointAnimationCommand &	operator= (const RemoveJointAnimationCommand &)=delete
DNACAPI	RemoveJointAnimationCommand (RemoveJointAnimationCommand &&)
DNACAPI RemoveJointAnimationCommand &	operator= (RemoveJointAnimationCommand &&)
DNACAPI void	setJointIndex (std::uint16_t jointIndex)
	Method for setting the index of a joint whose animation data to remove. More...
DNACAPI void	setJointIndices (ConstArrayView< std::uint16_t > jointIndices)
	Method for setting the indices of joints whose animation data to remove. More...
DNACAPI void	run (DNACalibDNAReader *output) override
Public Member Functions inherited from dnac::Command
virtual	~Command ()
virtual void	run (DNACalibDNAReader *output)=0

Private Attributes
ScopedPtr< Impl >	pImpl

Detailed Description

RemoveJointAnimationCommand is used to remove joint animation data.

Constructor & Destructor Documentation

RemoveJointAnimationCommand() [1/5]

dnac::RemoveJointAnimationCommand::RemoveJointAnimationCommand ( MemoryResource *  memRes = nullptr )

explicit

                                                                               : pImpl{makeScoped<Impl>(memRes)} {
}

RemoveJointAnimationCommand() [2/5]

dnac::RemoveJointAnimationCommand::RemoveJointAnimationCommand	(	std::uint16_t	jointIndex,
		MemoryResource *	memRes = nullptr
	)

                                                                                                       :
    pImpl{makeScoped<Impl>(memRes)} {
 
    pImpl->setJointIndex(jointIndex);
}

References pImpl.

RemoveJointAnimationCommand() [3/5]

dnac::RemoveJointAnimationCommand::RemoveJointAnimationCommand	(	ConstArrayView< std::uint16_t >	jointIndices,
		MemoryResource *	memRes = nullptr
	)

                                                                                                                         :
    pImpl{makeScoped<Impl>(memRes)} {
 
    pImpl->setJointIndices(jointIndices);
}

References pImpl.

~RemoveJointAnimationCommand()

dnac::RemoveJointAnimationCommand::~RemoveJointAnimationCommand ( )

default

RemoveJointAnimationCommand() [4/5]

dnac::RemoveJointAnimationCommand::RemoveJointAnimationCommand ( const RemoveJointAnimationCommand &  )

delete

RemoveJointAnimationCommand() [5/5]

dnac::RemoveJointAnimationCommand::RemoveJointAnimationCommand ( RemoveJointAnimationCommand &&  )

default

Member Function Documentation

operator=() [1/2]

RemoveJointAnimationCommand & dnac::RemoveJointAnimationCommand::operator= ( const RemoveJointAnimationCommand &  )

delete

operator=() [2/2]

RemoveJointAnimationCommand & dnac::RemoveJointAnimationCommand::operator= ( RemoveJointAnimationCommand &&  )

default

run()

void dnac::RemoveJointAnimationCommand::run ( DNACalibDNAReader *  output )

overridevirtual

Implements dnac::Command.

                                                               {
    pImpl->run(static_cast<DNACalibDNAReaderImpl*>(output));
}

References pImpl.

setJointIndex()

void dnac::RemoveJointAnimationCommand::setJointIndex

(

std::uint16_t

jointIndex

)

Method for setting the index of a joint whose animation data to remove.

Parameters

jointIndex

The index of the joint.

Note

Call to either setter overwrites previous setter calls. When running the command, the last set joint animation(s) will be removed.

                                                                      {
    pImpl->setJointIndex(jointIndex);
}

References pImpl.

setJointIndices()

void dnac::RemoveJointAnimationCommand::setJointIndices

(

ConstArrayView< std::uint16_t >

jointIndices

)

Method for setting the indices of joints whose animation data to remove.

Parameters

jointIndices

The joint indices.

Note

Call to either setter overwrites previous setter calls. When running the command, the last set joint animation(s) will be removed.

                                                                                          {
    pImpl->setJointIndices(jointIndices);
}

References pImpl.

Member Data Documentation

pImpl

ScopedPtr<Impl> dnac::RemoveJointAnimationCommand::pImpl

private

Referenced by RemoveJointAnimationCommand(), run(), setJointIndex(), and setJointIndices().

---

The documentation for this class was generated from the following files:

• RemoveJointAnimationCommand.h
• RemoveJointAnimationCommand.cpp