Murl::Graph::IResetTransform Interface Referenceabstract

The IResetTransform graph node interface. More...

#include "murl_graph_i_reset_transform.h"

Inheritance diagram for Murl::Graph::IResetTransform:

Public Member Functions

virtual INodeGetNodeInterface ()=0
 Get the mutable Graph::INode interface. More...
 
virtual const INodeGetNodeInterface () const =0
 Get the constant Graph::INode interface. More...
 
virtual Bool SetAffectRotationEnabled (Bool enabled)=0
 Enable/disable resetting of the current world rotation. More...
 
virtual Bool IsAffectRotationEnabled () const =0
 Check if resetting of the current world rotation is enabled. More...
 
virtual Bool SetAffectTranslationEnabled (Bool enabled)=0
 Enable/disable resetting of the current world translation. More...
 
virtual Bool IsAffectTranslationEnabled () const =0
 Check if resetting of the current world translation is enabled. More...
 
virtual Bool SetAffectDepthOrderEnabled (Bool enabled)=0
 Enable/disable resetting of the current depth order. More...
 
virtual Bool IsAffectDepthOrderEnabled () const =0
 Check if resetting of the current depth order is enabled. More...
 

Detailed Description

The IResetTransform graph node interface.

Nodes implementing this interface can be used to reset the position and/or rotation component of the currently active combined transform on the transform stack. This can be useful if e.g. a camera is attached to a moving object, but should always look in a specific direction regardless of the object's actual orientation. In such a case, an IResetTransform node can be inserted below the object and above the camera, with calling SetAffectTranslationEnabled(false) to retain the object's position, and SetAffectRotationEnabled(true) to reset its rotation to the identity 3x3 matrix.

Note, that like all other transform nodes, the effect is limited to this node's children; all siblings of this node are not affected.

Member Function Documentation

◆ GetNodeInterface() [1/2]

virtual INode* Murl::Graph::IResetTransform::GetNodeInterface ( )
pure virtual

Get the mutable Graph::INode interface.

This method returns a mutable pointer to the node's Graph::INode interface, to be able to query or modify common node properties such as active state, visibility or ID.

Returns
The mutable Graph::INode interface, or null if not available

◆ GetNodeInterface() [2/2]

virtual const INode* Murl::Graph::IResetTransform::GetNodeInterface ( ) const
pure virtual

Get the constant Graph::INode interface.

This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.

Returns
The constant Graph::INode interface, or null if not available

◆ SetAffectRotationEnabled()

virtual Bool Murl::Graph::IResetTransform::SetAffectRotationEnabled ( Bool  enabled)
pure virtual

Enable/disable resetting of the current world rotation.

Parameters
enabledIf true, the rotation part of the current world transform is reset to the 3x3 identity matrix.
Returns
true if successful.

◆ IsAffectRotationEnabled()

virtual Bool Murl::Graph::IResetTransform::IsAffectRotationEnabled ( ) const
pure virtual

Check if resetting of the current world rotation is enabled.

Returns
true if enabled.

◆ SetAffectTranslationEnabled()

virtual Bool Murl::Graph::IResetTransform::SetAffectTranslationEnabled ( Bool  enabled)
pure virtual

Enable/disable resetting of the current world translation.

Parameters
enabledIf true, the translation part of the current world transform is reset to the zero position vector.
Returns
true if successful.

◆ IsAffectTranslationEnabled()

virtual Bool Murl::Graph::IResetTransform::IsAffectTranslationEnabled ( ) const
pure virtual

Check if resetting of the current world translation is enabled.

Returns
true if enabled.

◆ SetAffectDepthOrderEnabled()

virtual Bool Murl::Graph::IResetTransform::SetAffectDepthOrderEnabled ( Bool  enabled)
pure virtual

Enable/disable resetting of the current depth order.

Parameters
enabledIf true, the depth order is reset to zero.
Returns
true if successful.

◆ IsAffectDepthOrderEnabled()

virtual Bool Murl::Graph::IResetTransform::IsAffectDepthOrderEnabled ( ) const
pure virtual

Check if resetting of the current depth order is enabled.

Returns
true if enabled.

The documentation for this interface was generated from the following file:
  • murl_graph_i_reset_transform.h


Copyright © 2011-2018 Spraylight GmbH.