Draggable3DOrientation Class Reference

Stores a 3D orientation, which can be rotated by dragging with the mouse. More...

#include <juce_Draggable3DOrientation.h>

Collaboration diagram for Draggable3DOrientation:

Public Types
typedef Quaternion< float >	QuaternionType
typedef Vector3D< float >	VectorType

Public Member Functions
	Draggable3DOrientation (float objectRadius=0.5f) noexcept
	Creates a Draggable3DOrientation, initially set up to be aligned along the X axis. More...
	Draggable3DOrientation (const Quaternion< float > &quaternionToUse, float objectRadius=0.5f) noexcept
	Creates a Draggable3DOrientation from a user-supplied quaternion. More...
QuaternionType &	getQuaternion () noexcept
	Provides direct access to the quaternion. More...
Matrix3D< float >	getRotationMatrix () const noexcept
	Returns the matrix that should be used to apply the current orientation. More...
template<typename Type >
void	mouseDown (Point< Type > mousePos) noexcept
	Begins a mouse-drag operation. More...
template<typename Type >
void	mouseDrag (Point< Type > mousePos) noexcept
	Continues a mouse-drag operation. More...
void	reset (const VectorType &axis) noexcept
	Resets the orientation, specifying the axis to align it along. More...
void	setRadius (float newRadius) noexcept
	Sets the size of the rotated object, as a proportion of the viewport's size. More...
void	setViewport (const Rectangle< int > &newArea) noexcept
	Sets the viewport area within which mouse-drag positions will occur. More...

Private Member Functions
Point< float >	mousePosToProportion (const Point< float > mousePos) const noexcept
VectorType	projectOnSphere (const Point< float > pos) const noexcept
QuaternionType	rotationFromMove (const VectorType &from, const VectorType &to) const noexcept

Private Attributes
Rectangle< int >	area
Point< float >	lastMouse
QuaternionType	quaternion
float	radius

Detailed Description

Stores a 3D orientation, which can be rotated by dragging with the mouse.

Member Typedef Documentation

QuaternionType

typedef Quaternion<float> Draggable3DOrientation::QuaternionType

VectorType

typedef Vector3D<float> Draggable3DOrientation::VectorType

Constructor & Destructor Documentation

Draggable3DOrientation() [1/2]

Draggable3DOrientation::Draggable3DOrientation ( float  objectRadius = 0.5f )

inlinenoexcept

Creates a Draggable3DOrientation, initially set up to be aligned along the X axis.

Draggable3DOrientation() [2/2]

Draggable3DOrientation::Draggable3DOrientation ( const Quaternion< float > &  quaternionToUse, float  objectRadius = 0.5f  )

inlinenoexcept

Creates a Draggable3DOrientation from a user-supplied quaternion.

Member Function Documentation

getQuaternion()

QuaternionType& Draggable3DOrientation::getQuaternion ( )

inlinenoexcept

Provides direct access to the quaternion.

References quaternion.

getRotationMatrix()

Matrix3D<float> Draggable3DOrientation::getRotationMatrix ( ) const

inlinenoexcept

Returns the matrix that should be used to apply the current orientation.

See also

applyToOpenGLMatrix

References Quaternion< Type >::getRotationMatrix(), and quaternion.

mouseDown()

template<typename Type >

void Draggable3DOrientation::mouseDown ( Point< Type >  mousePos )

inlinenoexcept

Begins a mouse-drag operation.

You must call this before any calls to mouseDrag(). The position that is supplied will be treated as being relative to the centre of the rectangle passed to setViewport().

References lastMouse, and mousePosToProportion().

mouseDrag()

template<typename Type >

void Draggable3DOrientation::mouseDrag ( Point< Type >  mousePos )

inlinenoexcept

Continues a mouse-drag operation.

After calling mouseDown() to begin a drag sequence, you can call this method to continue it.

References lastMouse, mousePosToProportion(), projectOnSphere(), quaternion, and rotationFromMove().

mousePosToProportion()

Point<float> Draggable3DOrientation::mousePosToProportion ( const Point< float >  mousePos ) const

inlineprivatenoexcept

References Rectangle< ValueType >::getCentreX(), Rectangle< ValueType >::getCentreY(), Rectangle< ValueType >::getHeight(), Rectangle< ValueType >::getWidth(), jassert, juce::jmin(), and scale.

Referenced by mouseDown(), and mouseDrag().

projectOnSphere()

VectorType Draggable3DOrientation::projectOnSphere ( const Point< float >  pos ) const

inlineprivatenoexcept

References radius.

Referenced by mouseDrag().

reset()

void Draggable3DOrientation::reset ( const VectorType &  axis )

inlinenoexcept

Resets the orientation, specifying the axis to align it along.

References quaternion.

rotationFromMove()

QuaternionType Draggable3DOrientation::rotationFromMove ( const VectorType &  from, const VectorType &  to  ) const

inlineprivatenoexcept

References Quaternion< Type >::fromAngle(), jlimit(), Vector3D< Type >::lengthIsBelowEpsilon(), and Vector3D< Type >::xAxis().

Referenced by mouseDrag().

setRadius()

void Draggable3DOrientation::setRadius ( float  newRadius )

inlinenoexcept

Sets the size of the rotated object, as a proportion of the viewport's size.

See also

setViewport

References juce::jmax(), and radius.

setViewport()

void Draggable3DOrientation::setViewport ( const Rectangle< int > &  newArea )

inlinenoexcept

Sets the viewport area within which mouse-drag positions will occur.

You'll need to set this rectangle before calling mouseDown. The centre of the rectangle is assumed to be the centre of the object that will be rotated, and the size of the rectangle will be used to scale the object radius - see setRadius().

References area.

Member Data Documentation

area

Rectangle<int> Draggable3DOrientation::area

private

Referenced by setViewport().

lastMouse

Point<float> Draggable3DOrientation::lastMouse

private

Referenced by mouseDown(), and mouseDrag().

quaternion

QuaternionType Draggable3DOrientation::quaternion

private

Referenced by getQuaternion(), getRotationMatrix(), mouseDrag(), and reset().

radius

float Draggable3DOrientation::radius

private

Referenced by projectOnSphere(), and setRadius().

---

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

• juce_Draggable3DOrientation.h