Classes
class	maquina::NodeDelegate::TransformUserData
	A blind data provided by the start_transform's implementation and passed to set_scale, set_rotation and set_translation. More...

Enumerations
enum	maquina::NodeDelegate::MutableFlags { maquina::NodeDelegate::ScaleX = 0x001, maquina::NodeDelegate::ScaleY = 0x002, maquina::NodeDelegate::ScaleZ = 0x004, maquina::NodeDelegate::Scale = ScaleX\|ScaleY\|ScaleZ, maquina::NodeDelegate::RotateX = 0x008, maquina::NodeDelegate::RotateY = 0x010, maquina::NodeDelegate::RotateZ = 0x020, maquina::NodeDelegate::Rotate = RotateX\|RotateY\|RotateZ, maquina::NodeDelegate::TranslateX = 0x040, maquina::NodeDelegate::TranslateY = 0x080, maquina::NodeDelegate::TranslateZ = 0x100, maquina::NodeDelegate::Translate = TranslateX\|TranslateY\|TranslateZ, maquina::NodeDelegate::AllComponents = Scale\|Rotate\|Translate }

Functions
virtual bool	maquina::NodeDelegate::has_transform () const
	Return true if this node is has a transformation matrix. More...

virtual Imath::M44d	maquina::NodeDelegate::matrix (const QueryContext &qc=QueryContext::at_current_frame) const
	Return the node's local matrix which transforms a point from the local node space to the parent space. More...

virtual Imath::M44d	maquina::NodeDelegate::world_matrix (const QueryContext &qc=QueryContext::at_current_frame) const
	Return the node's world matrix which transforms a point from the local node space to the world space. More...

virtual Imath::M44d	maquina::NodeDelegate::parent_world_matrix (const QueryContext &qc=QueryContext::at_current_frame) const
	Return the node parent's world matrix which transforms a point from the parent space to the world space. More...

virtual Imath::V3d	maquina::NodeDelegate::rotate_pivot (const QueryContext &qc=QueryContext::at_current_frame) const

virtual Imath::V3d	maquina::NodeDelegate::scale_pivot (const QueryContext &qc=QueryContext::at_current_frame) const

virtual Imath::V3d	maquina::NodeDelegate::joint_orient (const QueryContext &qc=QueryContext::at_current_frame) const

virtual Imath::V3d	maquina::NodeDelegate::rotate_axis (const QueryContext &qc=QueryContext::at_current_frame) const

virtual int	maquina::NodeDelegate::mutable_flags () const
	Returns the mutable transformation component. More...

virtual std::unique_ptr< TransformUserData >	maquina::NodeDelegate::start_transform (const QueryContext &qc=QueryContext::at_current_frame)
	Start a transform modification, time to backup an initial state. More...

virtual void	maquina::NodeDelegate::end_transform (const ModificationContext &mc=ModificationContext::default_mc(), TransformUserData *user_data=nullptr)
	End a transform modification, time to backup an initial state. More...

virtual void	maquina::NodeDelegate::set_matrix (const Imath::M44d &matrix, const ModificationContext &mc=ModificationContext::default_mc(), TransformUserData *user_data=nullptr)
	Set the node matrix. More...

virtual Imath::V3d	maquina::NodeDelegate::scale (const QueryContext &qc=QueryContext::at_current_frame) const
	Return the scale of the node matrix. More...

virtual void	maquina::NodeDelegate::set_scale (const Imath::V3d &scale, const ModificationContext &mc=ModificationContext::default_mc(), TransformUserData *user_data=nullptr)
	Set the scale of the node matrix. More...

virtual Imath::V3d	maquina::NodeDelegate::rotation (const QueryContext &qc=QueryContext::at_current_frame) const
	Return the node matrix's rotation as euler radians angles in the order returned by rotation_order. More...

virtual Imath::Eulerd::Order	maquina::NodeDelegate::rotate_order (const QueryContext &qc=QueryContext::at_current_frame) const
	Return the node rotate order. More...

virtual void	maquina::NodeDelegate::set_rotation (const Imath::V3d &rotation, const ModificationContext &mc=ModificationContext::default_mc(), TransformUserData *user_data=nullptr)
	Set the transformation rotation. More...

virtual Imath::V3d	maquina::NodeDelegate::translation (const QueryContext &qc=QueryContext::at_current_frame) const
	Return the node's translation. More...

virtual void	maquina::NodeDelegate::set_translation (const Imath::V3d &translation, const ModificationContext &mc=ModificationContext::default_mc(), TransformUserData *user_data=nullptr)
	Set the translation of the node matrix. More...

Imath::V3d	maquina::NodeDelegate::extract_translation (const Imath::M44d &local_matrix, const QueryContext &mc=QueryContext::at_current_frame) const
	A helper function to extract the node delegate translation component out of a local matrix, regarding the different pivots. More...

Imath::V3d	maquina::NodeDelegate::extract_rotation (Imath::M44d local_matrix, const QueryContext &mc=QueryContext::at_current_frame) const
	A helper function to extract the node delegate rotation component out of a local matrix, regarding the joint_orient and rotate_axis. More...

virtual std::shared_ptr< Observer >	maquina::NodeDelegate::create_transform_observer (const std::function< void()> &func, bool in_interactive=true)
	Create an observer notified when the NodeDelegate transform attributes have changed. More...

Detailed Description

Enumeration Type Documentation

◆ MutableFlags

enum maquina::NodeDelegate::MutableFlags

Enumerator
ScaleX	The x scale component is mutable.
ScaleY	The y scale component is mutable.
ScaleZ	The z scale component is mutable.
Scale	The scale is mutable.
RotateX	The x rotation component is mutable.
RotateY	The y rotation component is mutable.
RotateZ	The z rotation component is mutable.
Rotate	The rotation is mutable.
TranslateX	The x translation component is mutable.
TranslateY	The y translation component is mutable.
TranslateZ	The z translation component is mutable.
Translate	The translation is mutable.
AllComponents	All the transformation components are mutable.

Function Documentation

◆ create_transform_observer()

virtual std::shared_ptr<Observer> maquina::NodeDelegate::create_transform_observer	(	const std::function< void()> &	func,
		bool	in_interactive = `true`
	)

virtual

Create an observer notified when the NodeDelegate transform attributes have changed.

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ end_transform()

virtual void maquina::NodeDelegate::end_transform	(	const ModificationContext &	mc = `ModificationContext::default_mc()`,
		TransformUserData *	user_data = `nullptr`
	)

virtual

End a transform modification, time to backup an initial state.

This method is called by the transform tools at the end of a transformation modification.

Reimplemented in maquina::NodeDelegateWrapper.

◆ extract_rotation()

Imath::V3d maquina::NodeDelegate::extract_rotation	(	Imath::M44d	local_matrix,
		const QueryContext &	mc = `QueryContext::at_current_frame`
	)		const

A helper function to extract the node delegate rotation component out of a local matrix, regarding the joint_orient and rotate_axis.

◆ extract_translation()

Imath::V3d maquina::NodeDelegate::extract_translation	(	const Imath::M44d &	local_matrix,
		const QueryContext &	mc = `QueryContext::at_current_frame`
	)		const

A helper function to extract the node delegate translation component out of a local matrix, regarding the different pivots.

◆ has_transform()

virtual bool maquina::NodeDelegate::has_transform ( ) const

virtual

Return true if this node is has a transformation matrix.

If has_transform returns true, the node has a matrix, a parent_world_matrix and a world_matrix.

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ joint_orient()

virtual Imath::V3d maquina::NodeDelegate::joint_orient ( const QueryContext & qc = QueryContext::at_current_frame ) const

virtual

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ matrix()

virtual Imath::M44d maquina::NodeDelegate::matrix ( const QueryContext & qc = QueryContext::at_current_frame ) const

virtual

Return the node's local matrix which transforms a point from the local node space to the parent space.

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ mutable_flags()

virtual int maquina::NodeDelegate::mutable_flags ( ) const

virtual

Returns the mutable transformation component.

If a flag is set, its component is mutable.

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ parent_world_matrix()

virtual Imath::M44d maquina::NodeDelegate::parent_world_matrix ( const QueryContext & qc = QueryContext::at_current_frame ) const

virtual

Return the node parent's world matrix which transforms a point from the parent space to the world space.

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ rotate_axis()

virtual Imath::V3d maquina::NodeDelegate::rotate_axis ( const QueryContext & qc = QueryContext::at_current_frame ) const

virtual

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ rotate_order()

virtual Imath::Eulerd::Order maquina::NodeDelegate::rotate_order ( const QueryContext & qc = QueryContext::at_current_frame ) const

virtual

Return the node rotate order.

The default implementation returns Imath::Eulerd::Order::XYZ.

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ rotate_pivot()

virtual Imath::V3d maquina::NodeDelegate::rotate_pivot ( const QueryContext & qc = QueryContext::at_current_frame ) const

virtual

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ rotation()

virtual Imath::V3d maquina::NodeDelegate::rotation ( const QueryContext & qc = QueryContext::at_current_frame ) const

virtual

Return the node matrix's rotation as euler radians angles in the order returned by rotation_order.

This value does not include the joint orient term

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ scale()

virtual Imath::V3d maquina::NodeDelegate::scale ( const QueryContext & qc = QueryContext::at_current_frame ) const

virtual

Return the scale of the node matrix.

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ scale_pivot()

virtual Imath::V3d maquina::NodeDelegate::scale_pivot ( const QueryContext & qc = QueryContext::at_current_frame ) const

virtual

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ set_matrix()

virtual void maquina::NodeDelegate::set_matrix	(	const Imath::M44d &	matrix,
		const ModificationContext &	mc = `ModificationContext::default_mc()`,
		TransformUserData *	user_data = `nullptr`
	)

virtual

Set the node matrix.

This matrix will replace the current one. user_data is the blind data returned by start_transform.

Reimplemented in maquina::NodeDelegateWrapper.

◆ set_rotation()

virtual void maquina::NodeDelegate::set_rotation	(	const Imath::V3d &	rotation,
		const ModificationContext &	mc = `ModificationContext::default_mc()`,
		TransformUserData *	user_data = `nullptr`
	)

virtual

Set the transformation rotation.

This rotation value will replace the current one. The euler angles are in radians in the rotate order returned by rotate_order(). user_data is the blind data returned by start_transform.

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ set_scale()

virtual void maquina::NodeDelegate::set_scale	(	const Imath::V3d &	scale,
		const ModificationContext &	mc = `ModificationContext::default_mc()`,
		TransformUserData *	user_data = `nullptr`
	)

virtual

Set the scale of the node matrix.

This scale value will replace the current one. user_data is the blind data returned by start_transform.

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ set_translation()

virtual void maquina::NodeDelegate::set_translation	(	const Imath::V3d &	translation,
		const ModificationContext &	mc = `ModificationContext::default_mc()`,
		TransformUserData *	user_data = `nullptr`
	)

virtual

Set the translation of the node matrix.

This translation value will replace the current one. user_data is the blind data returned by start_transform.

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

◆ start_transform()

virtual std::unique_ptr<TransformUserData> maquina::NodeDelegate::start_transform ( const QueryContext & qc = QueryContext::at_current_frame )

virtual

Start a transform modification, time to backup an initial state.

The optional returned user data is passed to set_scale, set_rotation and set_translation. This can be used to store initial state data. Return nullptr if no user data is needed.

Reimplemented in maquina::NodeDelegateWrapper.

◆ translation()

virtual Imath::V3d maquina::NodeDelegate::translation ( const QueryContext & qc = QueryContext::at_current_frame ) const

virtual

Return the node's translation.

This value does not include the different pivots term

Reimplemented in maquina::NodeDelegateWrapper.

◆ world_matrix()

virtual Imath::M44d maquina::NodeDelegate::world_matrix ( const QueryContext & qc = QueryContext::at_current_frame ) const

virtual

Return the node's world matrix which transforms a point from the local node space to the world space.

Reimplemented in maquina::NodeDelegateWrapper, and maquina::NodeDelegateManipulator.

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ MutableFlags

Function Documentation

◆ create_transform_observer()

◆ end_transform()

◆ extract_rotation()

◆ extract_translation()

◆ has_transform()

◆ joint_orient()

◆ matrix()

◆ mutable_flags()

◆ parent_world_matrix()

◆ rotate_axis()

◆ rotate_order()

◆ rotate_pivot()

◆ rotation()

◆ scale()

◆ scale_pivot()

◆ set_matrix()

◆ set_rotation()

◆ set_scale()

◆ set_translation()

◆ start_transform()

◆ translation()

◆ world_matrix()