bundles/common/org.eclipse.apogy.common.topology.ui.viewer/src/org/eclipse/apogy/common/topology/ui/viewer/preferences/TopologyViewerLightingPreferencePage.java

/*******************************************************************************
 * Copyright (c) 2018 Agence spatiale canadienne / Canadian Space Agency
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Pierre Allard, 
 *     Regent L'Archeveque,
 *     Sebastien Gemme  - initial API and implementation
 * 
 * SPDX-License-Identifier: EPL-1.0
 *     
 *******************************************************************************/
package org.eclipse.apogy.common.topology.ui.viewer.preferences;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.apogy.common.ApogyCommonOSGiUtilities;
import org.eclipse.apogy.common.topology.ui.viewer.Activator;
import org.eclipse.core.runtime.preferences.IScopeContext;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.eclipse.jface.preference.ColorFieldEditor;
import org.eclipse.jface.preference.FieldEditor;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;
import org.eclipse.ui.preferences.ScopedPreferenceStore;
import org.eclipse.wb.swt.FieldLayoutPreferencePage;

public class TopologyViewerLightingPreferencePage extends FieldLayoutPreferencePage
		implements IWorkbenchPreferencePage {
	private ColorFieldEditor skyLightColorEditor;

	private AmbientLightDirectionComposite directionComposite;

	private final List<FieldEditor> editors = new ArrayList<FieldEditor>();

	/**
	 * Create the preference page.
	 */
	public TopologyViewerLightingPreferencePage() {
		ScopedPreferenceStore prefsStore = new ScopedPreferenceStore(InstanceScope.INSTANCE, ApogyCommonOSGiUtilities.INSTANCE.getBundleSymbolicName(getClass()));

		prefsStore.setSearchContexts(new IScopeContext[] { InstanceScope.INSTANCE });

		setPreferenceStore(prefsStore);
		setDescription("Lighting");
	}

	/**
	 * Create contents of the preference page.
	 * 
	 * @param parent
	 */
	@Override
	public Control createPageContents(Composite parent) {
		Composite container = new Composite(parent, SWT.NULL);
		container.setLayout(new GridLayout(1, true));

		Group ambientLightGroup = new Group(container, SWT.NONE);
		ambientLightGroup.setLayoutData(new GridData(SWT.FILL, SWT.TOP, true, true, 1, 1));
		ambientLightGroup.setLayout(new GridLayout(1, true));
		ambientLightGroup.setText("Sky Light");

		this.skyLightColorEditor = createColorFieldEditor(ambientLightGroup,
				TopologyViewerLightingPreferenceConstants.AMBIENT_LIGHT_COLOR_ID, "Sky Light Color");
		this.editors.add(this.skyLightColorEditor);

		// Fillers
		Label directionLabel = new Label(ambientLightGroup, SWT.NONE);
		directionLabel.setText("Light Direction :");

		this.directionComposite = new AmbientLightDirectionComposite(ambientLightGroup, SWT.BORDER);
		this.directionComposite.setDirection(
				TopologyViewerLightingPreferenceInitializer.getTuple3dFromPreferenceStore(getPreferenceStore()));

		return container;
	}

	@Override
	public void init(IWorkbench workbench) {
		setPreferenceStore(Activator.getDefault().getPreferenceStore());
	}

	@Override
	public boolean performOk() {
		storePreferences();
		return super.performOk();
	}

	@Override
	protected void performApply() {
		storePreferences();
		super.performApply();
	}

	@Override
	protected void performDefaults() {
		for (FieldEditor editor : this.editors) {
			editor.loadDefault();
		}

		String defaultDirectionString = getPreferenceStore()
				.getDefaultString(TopologyViewerLightingPreferenceConstants.AMBIENT_LIGHT_DIRECTION_ID);
		this.directionComposite.setDirection(TopologyViewerLightingPreferenceInitializer
				.getTuple3dFromPreferenceStoreString(defaultDirectionString));

		super.performDefaults();
	}

	@Override
	public void dispose() {
		this.editors.clear();
		super.dispose();
	}

	private void storePreferences() {
		for (FieldEditor editor : this.editors) {
			editor.store();
		}

		String directionString = TopologyViewerLightingPreferenceInitializer
				.getTuple3dPreferenceStoreString(this.directionComposite.getDirection());
		getPreferenceStore().setValue(TopologyViewerLightingPreferenceConstants.AMBIENT_LIGHT_DIRECTION_ID,
				directionString);
	}

	private ColorFieldEditor createColorFieldEditor(final Composite container, final String preferenceID,
			final String preferenceLabel) {
		Composite editorContainer = new Composite(container, SWT.NULL);
		editorContainer.setLayout(new GridLayout(1, true));
		editorContainer.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1));

		ColorFieldEditor editor = new ColorFieldEditor(preferenceID, preferenceLabel, editorContainer);
		editor.setPreferenceStore(getPreferenceStore());
		editor.load();

		return editor;
	}
}