#include <NodeDelegateRumba.h>

Inheritance diagram for maquina::NodeDelegateRumba:

Public Member Functions
	NodeDelegateRumba (const std::shared_ptr< Impl > &node)

StringView	type_name () const override
	From maquina::UserData. More...

std::shared_ptr< maquina::NodeDelegate >	parent () override
	From maquina::NodeDelegate. More...

maquina::StringView	name () const override
	The node's name. More...

std::string	path () const override
	Returns the full path to the node. More...

Imath::Box3d	bounding_box () const override
	Returns the bounding_box of the node. More...

bool	operator== (const maquina::NodeDelegate &o) const override
	Return true if both nodes are the same or both nodes are invalid. More...

bool	operator!= (const maquina::NodeDelegate &o) const override
	Return true if the nodes are different or if one is invalid. More...

int	child_count () const override
	Returns the number of children in the node. More...

std::shared_ptr< ChildIteratorDelegate >	_children_begin () override
	Return the begin iterator of the attributes. More...

std::shared_ptr< ChildIteratorDelegate >	_children_end () override
	Return the end iterator of the attributes. More...

std::shared_ptr< maquina::NodeDelegate >	find (const maquina::StringView &path) override
	Returns descendent node_delegate using a path starting at this node. More...

int	attribute_count () const override
	Returns the number of attributes. More...

std::shared_ptr< maquina::NodeDelegate::AttributeDelegate >	attribute (const maquina::StringView &name) override
	Return a node attribute using its name. More...

std::shared_ptr< AttributeIteratorDelegate >	_attributes_begin () override
	Return the begin iterator of the attributes. More...

std::shared_ptr< AttributeIteratorDelegate >	_attributes_end () override
	Return the end iterator of the attributes. More...

bool	is_node () const override
	Return true if this node delegate is a Rumba Node. More...

StringView	ui_description () const override
	Return UI description for this node delegate, empty if not specified. More...

maquina::Node	node () const override
	Return the node behind this node delegate. More...

void	channels (std::unordered_set< Plug > &result) const override

bool	is_camera () const
	Returns true if this node is a camera. More...

bool	is_orthographic (const QueryContext &qc=QueryContext::at_current_frame) const override
	Does this camera has an orthographic projection. More...

float	orthographic_width (const QueryContext &qc=QueryContext::at_current_frame) const override
	Return the orthographic width, the length projected in the width of the camera image. More...

void	set_orthographic_width (float width, const ModificationContext &mc) override
	Set the orthographic width. More...

float	center_of_interest (const QueryContext &qc=QueryContext::at_current_frame) const override
	Return the center of interest, the distance of the point the camera is looking at. More...

void	set_center_of_interest (float coi, const ModificationContext &mc) override
	Set the center of interest. More...

float	focal_length (const QueryContext &qc=QueryContext::at_current_frame) const override
	Return the focal length, in mm. More...

void	set_focal_length (float fl, const ModificationContext &mc) override
	Set the focal length, in mm. More...

float	horizontal_aperture (const QueryContext &qc=QueryContext::at_current_frame) const override
	Return the horizontal aperture, in cm. More...

void	set_horizontal_aperture (float horizontal_aperture, const ModificationContext &mc) override
	Set the horizontal aperture, in cm. More...

float	vertical_aperture (const QueryContext &qc=QueryContext::at_current_frame) const override
	Return the vertical aperture, in cm. More...

void	set_vertical_aperture (float vertical_aperture, const ModificationContext &mc) override
	Set the vertical aperture, in cm. More...

float	near_clipping_plane (const QueryContext &qc=QueryContext::at_current_frame) const override
	Return the near clipping plane. More...

void	set_near_clipping_plane (float near_clipping_plane, const ModificationContext &mc) override
	Set the near clipping plane. More...

float	far_clipping_plane (const QueryContext &qc=QueryContext::at_current_frame) const override
	Return the far clipping plane. More...

void	set_far_clipping_plane (float far_clipping_plane, const ModificationContext &mc) override
	Set the far clipping plane. More...

Public Member Functions inherited from maquina::NodeDelegate
virtual std::shared_ptr< NodeDelegate >	child (const StringView &name)
	Return a node child using its name. More...

Attributes	attributes ()

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

virtual Imath::M44d	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	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	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	rotate_pivot (const QueryContext &qc=QueryContext::at_current_frame) const

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

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

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

virtual void	start_transform (const QueryContext &qc=QueryContext::at_current_frame)
	Start a transform modification, time to backup an initial state. More...

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

virtual void	set_scale (const Imath::V3d &scale, const ModificationContext &mc=ModificationContext::layer)
	Set the scale of the node matrix. More...

virtual Imath::V3d	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	rotate_order (const QueryContext &qc=QueryContext::at_current_frame) const
	Return the node rotate order. More...

virtual void	set_rotation (const Imath::V3d &rotation, const ModificationContext &mc=ModificationContext::layer)
	Set the transformation rotation. More...

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

virtual void	set_translation (const Imath::V3d &translation, const ModificationContext &mc=ModificationContext::layer)
	Set the translation of the node matrix. More...

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

Public Member Functions inherited from maquina::UserData
virtual	~UserData ()

virtual std::shared_ptr< NodeDelegate >	node_delegate (const std::shared_ptr< NodeDelegate > &, const StringView &) const
	Override this method if the final type has a NodeDelegate. More...

virtual bool	has_node_delegate () const

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

Static Public Member Functions inherited from maquina::NodeDelegate
static Imath::V3d	extract_translation (const Imath::M44d &matrix, const Imath::V3d &scale_pivot, const Imath::V3d &rotate_pivot)
	An helper function to extract the translation component out of a local matrix and pivots. More...

Constructor & Destructor Documentation

◆ NodeDelegateRumba()

maquina::NodeDelegateRumba::NodeDelegateRumba ( const std::shared_ptr< Impl > & node )

inline

Member Function Documentation

◆ _attributes_begin()

std::shared_ptr<AttributeIteratorDelegate> maquina::NodeDelegateRumba::_attributes_begin ( )

overridevirtual

Return the begin iterator of the attributes.

Reimplemented from maquina::NodeDelegate.

◆ _attributes_end()

std::shared_ptr<AttributeIteratorDelegate> maquina::NodeDelegateRumba::_attributes_end ( )

overridevirtual

Return the end iterator of the attributes.

Reimplemented from maquina::NodeDelegate.

◆ _children_begin()

std::shared_ptr<ChildIteratorDelegate> maquina::NodeDelegateRumba::_children_begin ( )

overridevirtual

Return the begin iterator of the attributes.

Reimplemented from maquina::NodeDelegate.

◆ _children_end()

std::shared_ptr<ChildIteratorDelegate> maquina::NodeDelegateRumba::_children_end ( )

overridevirtual

Return the end iterator of the attributes.

Reimplemented from maquina::NodeDelegate.

◆ attribute()

std::shared_ptr<maquina::NodeDelegate::AttributeDelegate> maquina::NodeDelegateRumba::attribute ( const maquina::StringView & name )

overridevirtual

Return a node attribute using its name.

Return nullptr if the attribute does not exist.

Reimplemented from maquina::NodeDelegate.

◆ attribute_count()

int maquina::NodeDelegateRumba::attribute_count ( ) const

overridevirtual

Returns the number of attributes.

Reimplemented from maquina::NodeDelegate.

◆ bounding_box()

Imath::Box3d maquina::NodeDelegateRumba::bounding_box ( ) const

overridevirtual

Returns the bounding_box of the node.

Reimplemented from maquina::NodeDelegate.

◆ center_of_interest()

float maquina::NodeDelegateRumba::center_of_interest ( const QueryContext & qc = QueryContext::at_current_frame ) const

overridevirtual

Return the center of interest, the distance of the point the camera is looking at.

Reimplemented from maquina::NodeDelegate.

◆ channels()

void maquina::NodeDelegateRumba::channels ( std::unordered_set< Plug > & set ) const

overridevirtual

Return the animation channels of the represented node.

Reimplemented from maquina::NodeDelegate.

◆ child_count()

int maquina::NodeDelegateRumba::child_count ( ) const

overridevirtual

Returns the number of children in the node.

Implemented by the plug-in.

Reimplemented from maquina::NodeDelegate.

◆ far_clipping_plane()

float maquina::NodeDelegateRumba::far_clipping_plane ( const QueryContext & qc = QueryContext::at_current_frame ) const

overridevirtual

Return the far clipping plane.

Reimplemented from maquina::NodeDelegate.

◆ find()

std::shared_ptr<maquina::NodeDelegate> maquina::NodeDelegateRumba::find ( const maquina::StringView & path )

overridevirtual

Returns descendent node_delegate using a path starting at this node.

If the node_delegate does not exist, returns nullptr.

Reimplemented from maquina::NodeDelegate.

◆ focal_length()

float maquina::NodeDelegateRumba::focal_length ( const QueryContext & qc = QueryContext::at_current_frame ) const

overridevirtual

Return the focal length, in mm.

Reimplemented from maquina::NodeDelegate.

◆ horizontal_aperture()

float maquina::NodeDelegateRumba::horizontal_aperture ( const QueryContext & qc = QueryContext::at_current_frame ) const

overridevirtual

Return the horizontal aperture, in cm.

Reimplemented from maquina::NodeDelegate.

◆ is_camera()

bool maquina::NodeDelegateRumba::is_camera ( ) const

virtual

Returns true if this node is a camera.

Reimplemented from maquina::NodeDelegate.

◆ is_node()

bool maquina::NodeDelegateRumba::is_node ( ) const

overridevirtual

Return true if this node delegate is a Rumba Node.

Reimplemented from maquina::NodeDelegate.

◆ is_orthographic()

bool maquina::NodeDelegateRumba::is_orthographic ( const QueryContext & qc = QueryContext::at_current_frame ) const

overridevirtual

Does this camera has an orthographic projection.

Reimplemented from maquina::NodeDelegate.

◆ name()

maquina::StringView maquina::NodeDelegateRumba::name ( ) const

overridevirtual

The node's name.

Implemented by the plug-in.

Implements maquina::NodeDelegate.

◆ near_clipping_plane()

float maquina::NodeDelegateRumba::near_clipping_plane ( const QueryContext & qc = QueryContext::at_current_frame ) const

overridevirtual

Return the near clipping plane.

Reimplemented from maquina::NodeDelegate.

◆ node()

maquina::Node maquina::NodeDelegateRumba::node ( ) const

overridevirtual

Return the node behind this node delegate.

Exceptions

std::runtime_error if the node delegate is not mapped to a Node

Reimplemented from maquina::NodeDelegate.

◆ operator!=()

bool maquina::NodeDelegateRumba::operator!= ( const maquina::NodeDelegate & o ) const

overridevirtual

Return true if the nodes are different or if one is invalid.

Implemented by the plug-in.

Implements maquina::NodeDelegate.

◆ operator==()

bool maquina::NodeDelegateRumba::operator== ( const maquina::NodeDelegate & o ) const

overridevirtual

Return true if both nodes are the same or both nodes are invalid.

Implemented by the plug-in.

Implements maquina::NodeDelegate.

◆ orthographic_width()

float maquina::NodeDelegateRumba::orthographic_width ( const QueryContext & qc = QueryContext::at_current_frame ) const

overridevirtual

Return the orthographic width, the length projected in the width of the camera image.

Reimplemented from maquina::NodeDelegate.

◆ parent()

std::shared_ptr<maquina::NodeDelegate> maquina::NodeDelegateRumba::parent ( )

overridevirtual

From maquina::NodeDelegate.

Implements maquina::NodeDelegate.

◆ path()

std::string maquina::NodeDelegateRumba::path ( ) const

overridevirtual

Returns the full path to the node.

Implemented by the plug-in.

Implements maquina::NodeDelegate.

◆ set_center_of_interest()

void maquina::NodeDelegateRumba::set_center_of_interest	(	float	coi,
		const ModificationContext &	mc
	)

overridevirtual

Set the center of interest.

Reimplemented from maquina::NodeDelegate.

◆ set_far_clipping_plane()

void maquina::NodeDelegateRumba::set_far_clipping_plane	(	float	far_clipping_plane,
		const ModificationContext &	mc
	)

overridevirtual

Set the far clipping plane.

Reimplemented from maquina::NodeDelegate.

◆ set_focal_length()

void maquina::NodeDelegateRumba::set_focal_length	(	float	fl,
		const ModificationContext &	mc
	)

overridevirtual

Set the focal length, in mm.

Reimplemented from maquina::NodeDelegate.

◆ set_horizontal_aperture()

void maquina::NodeDelegateRumba::set_horizontal_aperture	(	float	horizontal_aperture,
		const ModificationContext &	mc
	)

overridevirtual

Set the horizontal aperture, in cm.

Reimplemented from maquina::NodeDelegate.

◆ set_near_clipping_plane()

void maquina::NodeDelegateRumba::set_near_clipping_plane	(	float	near_clipping_plane,
		const ModificationContext &	mc
	)

overridevirtual

Set the near clipping plane.

Reimplemented from maquina::NodeDelegate.

◆ set_orthographic_width()

void maquina::NodeDelegateRumba::set_orthographic_width	(	float	width,
		const ModificationContext &	mc
	)

overridevirtual

Set the orthographic width.

Reimplemented from maquina::NodeDelegate.

◆ set_vertical_aperture()

void maquina::NodeDelegateRumba::set_vertical_aperture	(	float	vertical_aperture,
		const ModificationContext &	mc
	)

overridevirtual

Set the vertical aperture, in cm.

Reimplemented from maquina::NodeDelegate.

◆ type_name()

StringView maquina::NodeDelegateRumba::type_name ( ) const

overridevirtual

From maquina::UserData.

Implements maquina::UserData.

◆ ui_description()

StringView maquina::NodeDelegateRumba::ui_description ( ) const

overridevirtual

Return UI description for this node delegate, empty if not specified.

Reimplemented from maquina::NodeDelegate.

◆ vertical_aperture()

float maquina::NodeDelegateRumba::vertical_aperture ( const QueryContext & qc = QueryContext::at_current_frame ) const

overridevirtual

Return the vertical aperture, in cm.

Reimplemented from maquina::NodeDelegate.

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

include/Maquina/NodeDelegateRumba.h

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ NodeDelegateRumba()

Member Function Documentation

◆ _attributes_begin()

◆ _attributes_end()

◆ _children_begin()

◆ _children_end()

◆ attribute()

◆ attribute_count()

◆ bounding_box()

◆ center_of_interest()

◆ channels()

◆ child_count()

◆ far_clipping_plane()

◆ find()

◆ focal_length()

◆ horizontal_aperture()

◆ is_camera()

◆ is_node()

◆ is_orthographic()

◆ name()

◆ near_clipping_plane()

◆ node()

◆ operator!=()

◆ operator==()

◆ orthographic_width()

◆ parent()

◆ path()

◆ set_center_of_interest()

◆ set_far_clipping_plane()

◆ set_focal_length()

◆ set_horizontal_aperture()

◆ set_near_clipping_plane()

◆ set_orthographic_width()

◆ set_vertical_aperture()

◆ type_name()

◆ ui_description()

◆ vertical_aperture()