GameFramework.MobileMenuObject

Extends: Object
Modifiers: native

Core.Object
|   
+-- GameFramework.MobileMenuObject

Direct Known Subclasses:

MobileMenuButton, MobileMenuImage, MobileMenuLabel

Constants Summary

Inherited Contants from Core.Object
AspectRatio16x9, AspectRatio4x3, AspectRatio5x4, DegToRad, DegToUnrRot, INDEX_NONE, InvAspectRatio16x9, InvAspectRatio4x3, InvAspectRatio5x4, MaxInt, Pi, RadToDeg, RadToUnrRot, UnrRotToDeg, UnrRotToRad

Variables Summary
bool	bApplyGlobalScaleHeight
bool	bApplyGlobalScaleLeft
bool	bApplyGlobalScaleTop
bool	bApplyGlobalScaleWidth
bool	bHasBeenInitialized
bool	bHeightRelativeToWidth
bool	bIsActive
bool	bIsHidden
bool	bIsHighlighted
bool	bIsTouched
float	BottomLeeway
bool	bRelativeHeight
bool	bRelativeLeft
bool	bRelativeTop
bool	bRelativeWidth
bool	bXOffsetIsActual
bool	bYOffsetIsActual
float	Height
MobilePlayerInput	InputOwner
float	Left
float	LeftLeeway
float	Opacity
MobileMenuScene	OwnerScene
float	RightLeeway
string	Tag
float	Top
float	TopLeeway
float	Width
float	XOffset
float	YOffset
Bounds
float	AuthoredGlobalScale

Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary

Inherited Enumerations from Core.Object
AlphaBlendType, EAspectRatioAxisConstraint, EAutomatedRunResult, EAxis, EDebugBreakType, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
UVCoords bCustomCoords, U, V, UL, VL

Inherited Structures from Core.Object
Array_Mirror, BitArray_Mirror, BoneAtom, Box, BoxSphereBounds, Color, Cylinder, double, FColorVertexBuffer_Mirror, Guid, IndirectArray_Mirror, InlinePointerArray_Mirror, InterpCurveFloat, InterpCurveLinearColor, InterpCurvePointFloat, InterpCurvePointLinearColor, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, OctreeElementId, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, RenderCommandFence_Mirror, Rotator, Set_Mirror, SHVector, SHVectorRGB, SparseArray_Mirror, TAlphaBlend, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Inherited Structures from Core.Object

Array_Mirror, BitArray_Mirror, BoneAtom, Box, BoxSphereBounds, Color, Cylinder, double, FColorVertexBuffer_Mirror, Guid, IndirectArray_Mirror, InlinePointerArray_Mirror, InterpCurveFloat, InterpCurveLinearColor, InterpCurvePointFloat, InterpCurvePointLinearColor, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, OctreeElementId, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, RenderCommandFence_Mirror, Rotator, Set_Mirror, SHVector, SHVectorRGB, SparseArray_Mirror, TAlphaBlend, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Functions Summary
		InitMenuObject (MobilePlayerInput PlayerInput, MobileMenuScene Scene, int ScreenWidth, int ScreenHeight))
		RenderObject (canvas Canvas))

Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, , , =, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, Atan2, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClampRotAxisFromBase, ClampRotAxisFromRange, ClassIsChildOf, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, DebugBreak, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, EvalInterpCurveFloat, EvalInterpCurveVector, EvalInterpCurveVector2D, Exp, FCeil, FClamp, FCubicInterp, FFloor, FindDeltaAngle, FindObject, FInterpConstantTo, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, float, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetBuildChangelistNumber, GetDotDistance, GetEngineVersion, GetEnum, GetFuncName, GetHeadingAngle, GetMappedRangeValue, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetRightMost, GetRotatorAxis, GetScriptTrace, GetStateName, GetSystemTime, GetUnAxes, GotoState, InCylinder, InStr, InverseTransformNormal, InverseTransformVector, IsA, IsChildState, IsInState, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, LerpColor, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, MakeRotationMatrix, MakeRotationTranslationMatrix, MakeRotator, MatrixGetAxis, MatrixGetOrigin, MatrixGetRotator, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, NoZDot, OrthoRotation, ParseLocalizedPropertyPath, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointDistToSegment, PointProjectToPlane, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, RTransform, SaveConfig, SClampRotAxis, ScriptTrace, SetUTracing, Sin, Split, SplitString, Sqrt, Square, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformNormal, TransformVector, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VRandCone, VRandCone2, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, \|, \|\|, ~, ~=

Inherited Functions from Core.Object

!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, Atan2, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClampRotAxisFromBase, ClampRotAxisFromRange, ClassIsChildOf, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, DebugBreak, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, EvalInterpCurveFloat, EvalInterpCurveVector, EvalInterpCurveVector2D, Exp, FCeil, FClamp, FCubicInterp, FFloor, FindDeltaAngle, FindObject, FInterpConstantTo, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, float, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetBuildChangelistNumber, GetDotDistance, GetEngineVersion, GetEnum, GetFuncName, GetHeadingAngle, GetMappedRangeValue, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetRightMost, GetRotatorAxis, GetScriptTrace, GetStateName, GetSystemTime, GetUnAxes, GotoState, InCylinder, InStr, InverseTransformNormal, InverseTransformVector, IsA, IsChildState, IsInState, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, LerpColor, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, MakeRotationMatrix, MakeRotationTranslationMatrix, MakeRotator, MatrixGetAxis, MatrixGetOrigin, MatrixGetRotator, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, NoZDot, OrthoRotation, ParseLocalizedPropertyPath, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointDistToSegment, PointProjectToPlane, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, RTransform, SaveConfig, SClampRotAxis, ScriptTrace, SetUTracing, Sin, Split, SplitString, Sqrt, Square, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformNormal, TransformVector, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VRandCone, VRandCone2, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=

Variables Detail

bApplyGlobalScaleHeight Source code

var bool bApplyGlobalScaleHeight;

bApplyGlobalScaleLeft Source code

var bool bApplyGlobalScaleLeft;

If any of these are set, then the Global scsale will be applied

bApplyGlobalScaleTop Source code

var bool bApplyGlobalScaleTop;

bApplyGlobalScaleWidth Source code

var bool bApplyGlobalScaleWidth;

bHasBeenInitialized Source code

var transient bool bHasBeenInitialized;

If true, the object has been initialized to the screen size (note, it will not work if the screen size changes)

bHeightRelativeToWidth Source code

var bool bHeightRelativeToWidth;

bIsActive Source code

var bool bIsActive;

If true, this control is considered to be active and accepts taps

bIsHidden Source code

var bool bIsHidden;

If true, this control is hidden and will not be rendered

bIsHighlighted Source code

var bool bIsHighlighted;

If true, this control is highlighted (like a radio button)

bIsTouched Source code

var bool bIsTouched;

If true, this control is being touched/pressed

BottomLeeway Source code

var float BottomLeeway;

bRelativeHeight Source code

var bool bRelativeHeight;

bRelativeLeft Source code

var bool bRelativeLeft;

If any of the bRelativeXXXX vars are set, then the value will be considered a percentage of the viewport

bRelativeTop Source code

var bool bRelativeTop;

bRelativeWidth Source code

var bool bRelativeWidth;

bXOffsetIsActual Source code

var bool bXOffsetIsActual;

Unlike Left/Top/Width/Height the XOffset and YOffsets are assumed to be a percentage of the bounds. If you

bYOffsetIsActual Source code

var bool bYOffsetIsActual;

Height Source code

var float Height;

The height of the menu

InputOwner Source code

var MobilePlayerInput InputOwner;

A reference to the input owner

Left Source code

var float Left;

The left position of the menu.

LeftLeeway Source code

var float LeftLeeway;

Opacity Source code

var float Opacity;

Holds the opacity of an object

OwnerScene Source code

var MobileMenuScene OwnerScene;

The scene this object is in

RightLeeway Source code

var float RightLeeway;

Tag Source code

var string Tag;

Holds the tag of this widget

Top Source code

var float Top;

The top position of the menu.

TopLeeway Source code

var float TopLeeway;

The Leeway values all you to subtle adjust the hitbox for an object.

Width Source code

var float Width;

The width of the menu.

XOffset Source code

var float XOffset;

The XOffset and YOffset can be used to shift the position of the widget within it's bounds.

YOffset Source code

var float YOffset;

Bounds

AuthoredGlobalScale Source code

var(Bounds) float AuthoredGlobalScale;

This is the scale factor you are authoring for. 2.0 is useful for Retina display resolution (960x640), 1.0 for iPads and older iPhones

Structures Detail

UVCoords Source code

struct UVCoords
{

var bool bCustomCoords;
var float U;
var float UL;
var float V;
var float VL;

};

U:
The UV coords.

Functions Detail

InitMenuObject Source code

function InitMenuObject ( MobilePlayerInput PlayerInput, MobileMenuScene Scene, int ScreenWidth, int ScreenHeight) )

InitMenuObject - Perform any initialization here
@param PlayerInput - A pointer to the MobilePlayerInput object that owns the UI system
@param Scene - The scene this object is in
@param ScreenWidth - The Width of the Screen
@param ScreenHeight - The Height of the Screen

RenderObject Source code

function RenderObject ( canvas Canvas) )

Render the widget
@param Canvas - the canvas object for drawing

Defaultproperties

defaultproperties
{
	Opacity=1.0
	AuthoredGlobalScale=2.0
}

Creation time: ti 22-3-2011 19:56:52.662 - Created with UnCodeX