documentation

VLAspectRatioFitter Class Reference

Modified version of the original AspectRatioFitter, which also handles rectTransforms with rotations around the z-axis. More...

Inherits UIBehaviour, and ILayoutSelfController.

Data Structures

class  SetPropertyUtility
 

Public Types

enum  AspectMode {
  AspectMode.None, AspectMode.WidthControlsHeight, AspectMode.HeightControlsWidth, AspectMode.FitInParent,
  AspectMode.EnvelopeParent
}
 

Public Member Functions

virtual void SetLayoutHorizontal ()
 
virtual void SetLayoutVertical ()
 

Protected Member Functions

 VLAspectRatioFitter ()
 
override void OnEnable ()
 
override void OnDisable ()
 
override void OnRectTransformDimensionsChange ()
 
void SetDirty (bool delayUpdate=false)
 

Properties

AspectMode aspectMode [get, set]
 
float aspectRatio [get, set]
 

Detailed Description

Modified version of the original AspectRatioFitter, which also handles rectTransforms with rotations around the z-axis.

The original code can be found here:

The original code was released under an MIT/X11 license:

The MIT License (MIT)

Copyright (c) 2014-2015, Unity Technologies

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Member Enumeration Documentation

◆ AspectMode

Enumerator
None 
WidthControlsHeight 
HeightControlsWidth 
FitInParent 
EnvelopeParent 

Constructor & Destructor Documentation

◆ VLAspectRatioFitter()

VLAspectRatioFitter.VLAspectRatioFitter ( )
inlineprotected

Member Function Documentation

◆ OnDisable()

override void VLAspectRatioFitter.OnDisable ( )
inlineprotected

◆ OnEnable()

override void VLAspectRatioFitter.OnEnable ( )
inlineprotected

◆ OnRectTransformDimensionsChange()

override void VLAspectRatioFitter.OnRectTransformDimensionsChange ( )
inlineprotected

◆ SetDirty()

void VLAspectRatioFitter.SetDirty ( bool  delayUpdate = false)
inlineprotected

◆ SetLayoutHorizontal()

virtual void VLAspectRatioFitter.SetLayoutHorizontal ( )
inlinevirtual

◆ SetLayoutVertical()

virtual void VLAspectRatioFitter.SetLayoutVertical ( )
inlinevirtual

Property Documentation

◆ aspectMode

AspectMode VLAspectRatioFitter.aspectMode
getset

◆ aspectRatio

float VLAspectRatioFitter.aspectRatio
getset