Murl Engine API  Version 2018.3
Murl::Graph::ITraversable Interface Referenceabstract

The ITraversable property interface. More...

#include <murl_graph_i_traversable.h>

Detailed Description

The ITraversable property interface.

Animation controllers may call the SetActive() and SetVisible() methods when appropriate keys are present in a given Resource::IAnimation.

Inheritance diagram for Murl::Graph::ITraversable:
Murl::Graph::INode Murl::Graph::Node Murl::Graph::Anchor Murl::Graph::AnchorState Murl::Graph::AnchorStateCopy Murl::Graph::AudioCullerState Murl::Graph::AudioCullerStateCopy Murl::Graph::AudioSource Murl::Graph::BoneState Murl::Graph::BoneStateCopy Murl::Graph::Camera Murl::Graph::CameraState Murl::Graph::CameraStateCopy Murl::Graph::Clip Murl::Graph::ClipSequencer Murl::Graph::ClipTransition Murl::Graph::CloneTransform Murl::Graph::ConstantBufferParameter Murl::Graph::ConstantBufferParameterGroup Murl::Graph::Contact Murl::Graph::Container Murl::Graph::Culler Murl::Graph::FrameBuffer Murl::Graph::Instance Murl::Graph::IslandState Murl::Graph::IslandStateCopy Murl::Graph::LayerState Murl::Graph::Light Murl::Graph::LightState Murl::Graph::LightStateCopy Murl::Graph::Listener Murl::Graph::ListenerState Murl::Graph::ListenerStateCopy Murl::Graph::Material Murl::Graph::MaterialState Murl::Graph::MaterialStateCopy Murl::Graph::MultiCamera Murl::Graph::MultiCuller Murl::Graph::MultiLight Murl::Graph::MultiMaterial Murl::Graph::MultiParameters Murl::Graph::MultiTexture Murl::Graph::MultiTimeline Murl::Graph::Namespace Murl::Graph::Parameters Murl::Graph::ParametersState Murl::Graph::ParametersStateCopy Murl::Graph::Program Murl::Graph::Reference Murl::Graph::ResetTransform Murl::Graph::Scale Murl::Graph::Shader Murl::Graph::StaticGeometryGroup Murl::Graph::SubState Murl::Graph::Surface Murl::Graph::SurfaceState Murl::Graph::SurfaceStateCopy Murl::Graph::Switch Murl::Graph::Template Murl::Graph::Texture Murl::Graph::TextureState Murl::Graph::TextureStateCopy Murl::Graph::Timeline Murl::Graph::TimelineState Murl::Graph::TimelineStateCopy Murl::Graph::Transform Murl::Graph::Variable Murl::Graph::VideoCullerState Murl::Graph::VideoCullerStateCopy Murl::Graph::VideoSource Murl::Graph::View

Public Member Functions

virtual Bool SetActive (Bool isActive)=0
 Enable/disable logic traversals. More...
 
virtual Bool IsActive () const =0
 Check if logic traversals are enabled. More...
 
virtual Bool SetVisible (Bool isVisible)=0
 Enable/disable output traversals. More...
 
virtual Bool IsVisible () const =0
 Check if output traversals are enabled. More...
 
virtual Bool SetActiveAndVisible (Bool enabled)=0
 Enable/disable both logic and output traversals. More...
 
virtual Bool IsActiveAndVisible () const =0
 Check if both logic and output traversals are enabled. More...
 

Member Function Documentation

◆ SetActive()

virtual Bool Murl::Graph::ITraversable::SetActive ( Bool  isActive)
pure virtual

Enable/disable logic traversals.

The 'active' state controls whether or not logic traversals are carried out on a node implementing this interface and its children.

Parameters
isActiveIf true, logic traversals are enabled.
Returns
true if successful.

◆ IsActive()

virtual Bool Murl::Graph::ITraversable::IsActive ( ) const
pure virtual

Check if logic traversals are enabled.

Returns
true if enabled.

◆ SetVisible()

virtual Bool Murl::Graph::ITraversable::SetVisible ( Bool  isVisible)
pure virtual

Enable/disable output traversals.

The 'visible' state controls whether or not output traversals are carried out on a node implementing this interface and its children.

Parameters
isVisibleIf true, output traversals are enabled.
Returns
true if successful.

◆ IsVisible()

virtual Bool Murl::Graph::ITraversable::IsVisible ( ) const
pure virtual

Check if output traversals are enabled.

Returns
true if enabled.

◆ SetActiveAndVisible()

virtual Bool Murl::Graph::ITraversable::SetActiveAndVisible ( Bool  enabled)
pure virtual

Enable/disable both logic and output traversals.

See also
SetActive()
SetVisible()
Parameters
enabledIf true, both logic and output traversals are enabled.
Returns
true if successful.

◆ IsActiveAndVisible()

virtual Bool Murl::Graph::ITraversable::IsActiveAndVisible ( ) const
pure virtual

Check if both logic and output traversals are enabled.

Returns
true if both are enabled.

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