tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
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...

#include "tracktion_ValueTreeUtilities.h"

Inheritance diagram for tracktion::engine::ReferenceCountedValueTree:
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.
 
 ~ReferenceCountedValueTree ()
 Destructor.
 
void setValueTree (juce::ValueTree newTree)
 Sets the ValueTree being held.
 
juce::ValueTree getValueTree () noexcept
 Returns the ValueTree being held.
 
- Public Member Functions inherited from juce::ReferenceCountedObject
void incReferenceCount () noexcept
 
void decReferenceCount () noexcept
 
bool decReferenceCountWithoutDeleting () noexcept
 
int getReferenceCount () const noexcept
 

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.
 

Additional Inherited Members

- Protected Member Functions inherited from juce::ReferenceCountedObject
 ReferenceCountedObject (const ReferenceCountedObject &) noexcept
 
 ReferenceCountedObject (ReferenceCountedObject &&) noexcept
 
ReferenceCountedObjectoperator= (const ReferenceCountedObject &) noexcept
 
ReferenceCountedObjectoperator= (ReferenceCountedObject &&) noexcept
 
void resetReferenceCount () noexcept
 

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.

Definition at line 413 of file tracktion_ValueTreeUtilities.h.

Member Typedef Documentation

◆ Ptr

Definition at line 430 of file tracktion_ValueTreeUtilities.h.

Constructor & Destructor Documentation

◆ ReferenceCountedValueTree()

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

Creates a ReferenceCountedValueTree for a given ValueTree.

Definition at line 417 of file tracktion_ValueTreeUtilities.h.

◆ ~ReferenceCountedValueTree()

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

Destructor.

Definition at line 422 of file tracktion_ValueTreeUtilities.h.

Member Function Documentation

◆ 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.

Definition at line 435 of file tracktion_ValueTreeUtilities.h.

◆ getValueTree()

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

Returns the ValueTree being held.

Definition at line 428 of file tracktion_ValueTreeUtilities.h.

◆ setValueTree()

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

Sets the ValueTree being held.

Definition at line 425 of file tracktion_ValueTreeUtilities.h.


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