ReaWwise

REAPER extension
Log | Files | Refs | Submodules

ImportConflictsComponent.cpp (6471B)

      1 /*----------------------------------------------------------------------------------------
      2 
      3 Copyright (c) 2023 AUDIOKINETIC Inc.
      4 
      5 This file is licensed to use under the license available at:
      6 https://github.com/audiokinetic/ReaWwise/blob/main/License.txt (the "License").
      7 You may not use this file except in compliance with the License.
      8 
      9 Unless required by applicable law or agreed to in writing, software distributed
     10 under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
     11 CONDITIONS OF ANY KIND, either express or implied.  See the License for the
     12 specific language governing permissions and limitations under the License.
     13 
     14 ----------------------------------------------------------------------------------------*/
     15 
     16 #include "ImportConflictsComponent.h"
     17 
     18 #include "Helpers/ImportHelper.h"
     19 #include "Model/IDs.h"
     20 
     21 namespace AK::WwiseTransfer
     22 {
     23 	namespace ImportConflictsComponentContants
     24 	{
     25 		constexpr int margin = 10;
     26 		constexpr int editorBoxHeight = 26;
     27 		constexpr int labelWidth = 136;
     28 		constexpr std::initializer_list<Import::ContainerNameExistsOption> containerNameExistsOptions{Import::ContainerNameExistsOption::UseExisting,
     29 			Import::ContainerNameExistsOption::CreateNew, Import::ContainerNameExistsOption::Replace};
     30 		constexpr std::initializer_list<Import::ApplyTemplateOption> applyTemplateOptions{Import::ApplyTemplateOption::Always,
     31 			Import::ApplyTemplateOption::NewObjectCreationOnly};
     32 		const juce::String pastePropertiesToolTip = "Paste properties are only available when connected to Wwise 2022+";
     33 	} // namespace ImportConflictsComponentContants
     34 
     35 	ImportConflictsComponent::ImportConflictsComponent(juce::ValueTree appState)
     36 		: applicationState(appState)
     37 		, containerNameExists(applicationState, IDs::containerNameExists, nullptr)
     38 		, applyTemplate(applicationState, IDs::applyTemplate, nullptr)
     39 	{
     40 		using namespace ImportConflictsComponentContants;
     41 
     42 		auto featureSupport = applicationState.getChildWithName(IDs::featureSupport);
     43 		applyTemplateFeatureEnabled.referTo(featureSupport, IDs::applyTemplateFeatureEnabled, nullptr);
     44 
     45 		containerNameExistsLabel.setText("If Sound Name Exists", juce::dontSendNotification);
     46 		containerNameExistsLabel.setBorderSize(juce::BorderSize(0));
     47 		containerNameExistsLabel.setMinimumHorizontalScale(1.0f);
     48 		containerNameExistsLabel.setJustificationType(juce::Justification::right);
     49 
     50 		applyTemplateLabel.setText("Apply Template", juce::dontSendNotification);
     51 		applyTemplateLabel.setBorderSize(juce::BorderSize(0));
     52 		applyTemplateLabel.setMinimumHorizontalScale(1.0f);
     53 		applyTemplateLabel.setJustificationType(juce::Justification::right);
     54 
     55 		for(auto& containerNameExistsOption : containerNameExistsOptions)
     56 			containerNameExistsComboBox.addItem(ImportHelper::containerNameExistsOptionToReadableString(containerNameExistsOption), static_cast<int>(containerNameExistsOption));
     57 
     58 		for(auto& applyTemplateOption : applyTemplateOptions)
     59 			applyTemplateComboBox.addItem(ImportHelper::applyTemplateOptionToReadableString(applyTemplateOption), static_cast<int>(applyTemplateOption));
     60 
     61 		containerNameExistsComboBox.getSelectedIdAsValue().referTo(containerNameExists.getPropertyAsValue());
     62 		applyTemplateComboBox.getSelectedIdAsValue().referTo(applyTemplate.getPropertyAsValue());
     63 
     64 		auto containerNameExistsComboBoxOnChange = [this]
     65 		{
     66 			const char* tooltip = "";
     67 			switch(static_cast<Import::ContainerNameExistsOption>(containerNameExistsComboBox.getSelectedId()))
     68 			{
     69 			case Import::ContainerNameExistsOption::UseExisting:
     70 				tooltip = "Retains the existing sounds but adds the transferred files as source audio "
     71 						  "files. The new files do not become the main audio sources for the existing "
     72 						  "objects unless they have identical names to the existing sources, and "
     73 						  "therefore overwrite them.";
     74 				break;
     75 
     76 			case Import::ContainerNameExistsOption::CreateNew:
     77 				tooltip = "Creates new sounds with increments appended to the names, for example "
     78 						  "SoundName_01. The existing sounds are not affected, unless the existing audio "
     79 						  "sources have the same names as the newly transferred files. In that case, the "
     80 						  "new sources overwrite the existing ones.";
     81 				break;
     82 
     83 			case Import::ContainerNameExistsOption::Replace:
     84 				tooltip = "Deletes and recreates the sounds, with the transferred files as sources.";
     85 				break;
     86 
     87 			default:
     88 				jassertfalse;
     89 				break;
     90 			}
     91 
     92 			containerNameExistsComboBox.setTooltip(tooltip);
     93 		};
     94 
     95 		containerNameExistsComboBoxOnChange();
     96 		containerNameExistsComboBox.onChange = containerNameExistsComboBoxOnChange;
     97 
     98 		addAndMakeVisible(containerNameExistsLabel);
     99 		addAndMakeVisible(applyTemplateLabel);
    100 		addAndMakeVisible(containerNameExistsComboBox);
    101 		addAndMakeVisible(applyTemplateComboBox);
    102 
    103 		refreshComponent();
    104 
    105 		applicationState.addListener(this);
    106 	}
    107 
    108 	ImportConflictsComponent::~ImportConflictsComponent()
    109 	{
    110 		applicationState.removeListener(this);
    111 	}
    112 
    113 	void ImportConflictsComponent::resized()
    114 	{
    115 		using namespace ImportConflictsComponentContants;
    116 
    117 		auto area = getLocalBounds();
    118 
    119 		auto containerNameSection = area.removeFromTop(editorBoxHeight);
    120 		{
    121 			containerNameExistsLabel.setBounds(containerNameSection.removeFromLeft(labelWidth));
    122 			containerNameSection.removeFromLeft(margin);
    123 
    124 			containerNameExistsComboBox.setBounds(containerNameSection);
    125 		}
    126 
    127 		area.removeFromTop(margin);
    128 
    129 		auto applyTemplateSection = area.removeFromTop(editorBoxHeight);
    130 		{
    131 			applyTemplateLabel.setBounds(applyTemplateSection.removeFromLeft(labelWidth));
    132 			applyTemplateSection.removeFromLeft(margin);
    133 
    134 			applyTemplateComboBox.setBounds(applyTemplateSection);
    135 		}
    136 	}
    137 
    138 	void ImportConflictsComponent::valueTreePropertyChanged(juce::ValueTree& treeWhosePropertyHasChanged, const juce::Identifier& property)
    139 	{
    140 		if(treeWhosePropertyHasChanged.getType() == IDs::featureSupport && property == IDs::applyTemplateFeatureEnabled)
    141 		{
    142 			triggerAsyncUpdate();
    143 		}
    144 	}
    145 
    146 	void ImportConflictsComponent::handleAsyncUpdate()
    147 	{
    148 		refreshComponent();
    149 	}
    150 
    151 	void ImportConflictsComponent::refreshComponent()
    152 	{
    153 		using namespace ImportConflictsComponentContants;
    154 
    155 		applyTemplateLabel.setEnabled(applyTemplateFeatureEnabled);
    156 		applyTemplateComboBox.setEnabled(applyTemplateFeatureEnabled);
    157 
    158 		applyTemplateLabel.setTooltip(applyTemplateFeatureEnabled ? "" : pastePropertiesToolTip);
    159 		applyTemplateComboBox.setTooltip(applyTemplateFeatureEnabled ? "" : pastePropertiesToolTip);
    160 	}
    161 } // namespace AK::WwiseTransfer