OpenWalnut  1.5.0dev
Public Member Functions | Private Attributes | List of all members
WManipulatorRotation Class Reference

A manipulator for rotating a dataset around an axis in the world coordinate system. More...

#include <WManipulatorRotation.h>

+ Inheritance diagram for WManipulatorRotation:
+ Collaboration diagram for WManipulatorRotation:

Public Member Functions

 WManipulatorRotation ()
 Constructor. More...
 
virtual ~WManipulatorRotation ()
 Destructor. More...
 
virtual WMatrixFixed< double, 4, 4 > getTransformationMatrix () const
 Get the transformation matrix from this manipulator. More...
 
virtual bool transformationChanged () const
 Check if the transform has changed, for example because of a change to properties. More...
 
virtual void reset ()
 Reset the transform. More...
 
- Public Member Functions inherited from WObjectNDIP< WManipulatorInterface >
virtual ~WObjectNDIP ()
 Destructor. More...
 
virtual std::string getName () const
 The name of the object. More...
 
virtual std::string getDescription () const
 The description of this object. More...
 
virtual const char ** getIcon () const
 The icon of this object. More...
 
virtual WProperties::SPtr getProperties ()
 Return the property group of this object. More...
 
- Public Member Functions inherited from WManipulatorInterface
virtual ~WManipulatorInterface ()
 Destructor. More...
 

Private Attributes

WPropPosition m_axis
 The axis to rotate around in world coordinates. More...
 
WPropDouble m_angle
 The angle to rotate. More...
 

Additional Inherited Members

- Public Types inherited from WObjectNDIP< WManipulatorInterface >
typedef std::shared_ptr< WObjectNDIPSPtr
 Shared ptr to an instance. More...
 
typedef std::shared_ptr< const WObjectNDIPConstSPtr
 Shared ptr to a const instance. More...
 
- Protected Member Functions inherited from WObjectNDIP< WManipulatorInterface >
 WObjectNDIP (std::string name, std::string description, const char **icon=NULL)
 Construct a NDIP'ed object. More...
 
- Protected Attributes inherited from WObjectNDIP< WManipulatorInterface >
WProperties::SPtr m_properties
 the properties of the object. More...
 

Detailed Description

A manipulator for rotating a dataset around an axis in the world coordinate system.

Definition at line 35 of file WManipulatorRotation.h.

Constructor & Destructor Documentation

◆ WManipulatorRotation()

WManipulatorRotation::WManipulatorRotation ( )

Constructor.

Definition at line 31 of file WManipulatorRotation.cpp.

References m_angle, m_axis, and WObjectNDIP< WManipulatorInterface >::m_properties.

◆ ~WManipulatorRotation()

WManipulatorRotation::~WManipulatorRotation ( )
virtual

Destructor.

Definition at line 40 of file WManipulatorRotation.cpp.

Member Function Documentation

◆ getTransformationMatrix()

WMatrixFixed< double, 4, 4 > WManipulatorRotation::getTransformationMatrix ( ) const
virtual

Get the transformation matrix from this manipulator.

Returns
The current transform.

Implements WManipulatorInterface.

Definition at line 44 of file WManipulatorRotation.cpp.

References WMatrixFixed< ValueT, Rows, Cols, ValueStoreT >::identity(), m_angle, and m_axis.

+ Here is the call graph for this function:

◆ reset()

void WManipulatorRotation::reset ( )
virtual

Reset the transform.

Implements WManipulatorInterface.

Definition at line 67 of file WManipulatorRotation.cpp.

References m_angle, and m_axis.

◆ transformationChanged()

bool WManipulatorRotation::transformationChanged ( ) const
virtual

Check if the transform has changed, for example because of a change to properties.

Returns
true, iff the transformation has changed.

Implements WManipulatorInterface.

Definition at line 62 of file WManipulatorRotation.cpp.

References m_angle, and m_axis.

Member Data Documentation

◆ m_angle

WPropDouble WManipulatorRotation::m_angle
private

The angle to rotate.

Definition at line 72 of file WManipulatorRotation.h.

Referenced by getTransformationMatrix(), reset(), transformationChanged(), and WManipulatorRotation().

◆ m_axis

WPropPosition WManipulatorRotation::m_axis
private

The axis to rotate around in world coordinates.

Definition at line 69 of file WManipulatorRotation.h.

Referenced by getTransformationMatrix(), reset(), transformationChanged(), and WManipulatorRotation().


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