TracktionEngine
Public Types | Public Member Functions | Static Public Member Functions | List of all members
tracktion::engine::ReferenceCountedValueTree Class Reference

Holds a ValueTree as a ReferenceCountedObject. More...

Inherits juce::ReferenceCountedObject.

Public Types

using Ptr = juce::ReferenceCountedObjectPtr< ReferenceCountedValueTree >
 

Public Member Functions

 ReferenceCountedValueTree (const juce::ValueTree &treeToReference) noexcept
 Creates a ReferenceCountedValueTree for a given ValueTree. More...
 
 ~ReferenceCountedValueTree ()
 Destructor. More...
 
void setValueTree (juce::ValueTree newTree)
 Sets the ValueTree being held. More...
 
juce::ValueTree getValueTree () noexcept
 Returns the ValueTree being held. More...
 

Static Public Member Functions

static juce::ValueTree getTreeFromObject (const juce::var &treeObject) noexcept
 Provides a simple way of getting the tree from a var object which is a ReferencedCountedValueTree. More...
 

Detailed Description

Holds a ValueTree as a ReferenceCountedObject.

This is somewhat obfuscated but makes it easy to transfer ValueTrees as var objects such as when using them as DragAndDropTarget::SourceDetails::description members.

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ ReferenceCountedValueTree()

tracktion::engine::ReferenceCountedValueTree::ReferenceCountedValueTree ( const juce::ValueTree &  treeToReference)
noexcept

Creates a ReferenceCountedValueTree for a given ValueTree.

◆ ~ReferenceCountedValueTree()

tracktion::engine::ReferenceCountedValueTree::~ReferenceCountedValueTree ( )

Destructor.

Member Function Documentation

◆ setValueTree()

void tracktion::engine::ReferenceCountedValueTree::setValueTree ( juce::ValueTree  newTree)

Sets the ValueTree being held.

◆ getValueTree()

juce::ValueTree tracktion::engine::ReferenceCountedValueTree::getValueTree ( )
noexcept

Returns the ValueTree being held.

◆ getTreeFromObject()

static juce::ValueTree tracktion::engine::ReferenceCountedValueTree::getTreeFromObject ( const juce::var &  treeObject)
staticnoexcept

Provides a simple way of getting the tree from a var object which is a ReferencedCountedValueTree.


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