org.mini2Dx.ui.layout.OffsetRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mini2Dx-ui Show documentation

null

There is a newer version: 2.0.0-alpha.32

/*******************************************************************************
 * Copyright 2019 See AUTHORS file
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package org.mini2Dx.ui.layout;

import org.mini2Dx.ui.element.UiElement;

/**
 * Common interface for {@link UiElement} x/y offset rules
 */
public interface OffsetRule {
	/**
	 * Determines the preferred offset of a {@link UiElement}
	 * 
	 * @param layoutState The current {@link LayoutState}
	 * @return The {@link UiElement} preferred offset
	 */
	public float getOffset(LayoutState layoutState);
}