Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.TextureFlipBook

Extends
Texture2D
Modifiers
native hidecategories ( Object ) inherits ( FTickableObject )

TextureFlipBook FlipBook texture support base class. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. 

Core.Object
|   
+-- Engine.Surface
   |   
   +-- Engine.Texture
      |   
      +-- Engine.Texture2D
         |   
         +-- Engine.TextureFlipBook
Variables Summary
boolbPaused
boolbStopped
intCurrentColumn
intCurrentRow
floatFrameTime
floatHorizontalScale
pointerReleaseResourcesFence
floatRenderOffsetU
floatRenderOffsetV
floatTimeIntoMovie
floatTimeSinceLastFrame
floatVerticalScale
FlipBook
boolbAutoPlay
boolbLooping
TextureFlipBookMethodFBMethod
floatFrameRate
intHorizontalImages
intVerticalImages
Inherited Variables from Engine.Texture2D
AddressX, AddressY, bForceMiplevelsToBeResident, bGlobalForceMipLevelsToBeResident, bHasBeenLoadedFromPersistentArchive, bHasCancelationPending, bIsStreamable, FirstResourceMemMip, Format, Mips, MipTailBaseIdx, PendingMipChangeRequestStatus, RequestedMips, ResidentMips, ResourceMem, SizeX, SizeY, StreamableTexturesLink, TextureFileCacheName, TimeToForceMipLevelsToBeResident
Inherited Variables from Engine.Texture
bAsyncResourceReleaseHasBeenStarted, bDitherMipMapAlpha, bPreserveBorderA, bPreserveBorderB, bPreserveBorderG, bPreserveBorderR, CachedCombinedLODBias, CompressionFullDynamicRange, CompressionNoAlpha, CompressionNoMipmaps, CompressionNone, CompressionSettings, DeferCompression, Filter, LODBias, LODGroup, NeverStream, Resource, RGBE, SourceArt, SourceFilePath, SourceFileTimestamp, SRGB, UnpackMax[4], UnpackMin[4]

Enumerations Summary
TextureFlipBookMethod
TFBM_UL_ROW, TFBM_UL_COL, TFBM_UR_ROW, TFBM_UR_COL, TFBM_LL_ROW, TFBM_LL_COL, TFBM_LR_ROW, TFBM_LR_COL, TFBM_RANDOM
Inherited Enumerations from Engine.Texture
EPixelFormat, TextureAddress, TextureCompressionSettings, TextureFilter, TextureGroup

Structures Summary
Inherited Structures from Engine.Texture2D
Texture2DMipMap, TextureLinkedListMirror

Functions Summary
function Pause ()
function Play ()
function SetCurrentFrame (int Row, int Col)
function Stop ()

Variables Detail

bPaused Source code

var const bool bPaused;
Whether the movie is currently paused.

bStopped Source code

var const bool bStopped;
Whether the movie is currently stopped.

CurrentColumn Source code

var const transient int CurrentColumn;
The current sub-image column

CurrentRow Source code

var const transient int CurrentRow;
The current sub-image row

FrameTime Source code

var private float FrameTime;

HorizontalScale Source code

var const transient float HorizontalScale;
The horizontal scale factor

ReleaseResourcesFence Source code

var native const pointer ReleaseResourcesFence;
Command fence used to shut down properly

RenderOffsetU Source code

var const transient float RenderOffsetU;
The current sub-image row for the render-thread

RenderOffsetV Source code

var const transient float RenderOffsetV;
The current sub-image column for the render-thread

TimeIntoMovie Source code

var const transient float TimeIntoMovie;
Time into the movie in seconds.

TimeSinceLastFrame Source code

var const transient float TimeSinceLastFrame;
Time that has passed since the last frame. Will be adjusted by decoder to combat drift.

VerticalScale Source code

var const transient float VerticalScale;
The vertical scale factor

FlipBook

bAutoPlay Source code

var(FlipBook) bool bAutoPlay;
Whether the movie should automatically start playing when it is loaded.

bLooping Source code

var(FlipBook) bool bLooping;
Whether the movie should loop when it reaches the end.

FBMethod Source code

var(FlipBook) TextureFlipBookMethod FBMethod;

FrameRate Source code

var(FlipBook) float FrameRate;
The time to display a single frame

HorizontalImages Source code

var(FlipBook) int HorizontalImages;
The horizontal and vertical sub-image count

VerticalImages Source code

var(FlipBook) int VerticalImages;

Enumerations Detail

TextureFlipBookMethod Source code

enum TextureFlipBookMethod
{
TFBM_UL_ROW, TFBM_UL_COL, TFBM_UR_ROW, TFBM_UR_COL, TFBM_LL_ROW, TFBM_LL_COL, TFBM_LR_ROW, TFBM_LR_COL, TFBM_RANDOM
};
FlipBookMethod This defines the order by which the images should be 'flipped through' TFBM_UL_ROW Start upper-left, go across to the the right, go to the next row down left-most and repeat. TFBM_UL_COL Start upper-left, go down to the bottom, pop to the top of the next column to the right and repeat. TFBM_UR_ROW Start upper-right, go across to the the left, go to the next row down right-most and repeat. TFBM_UR_COL Start upper-right, go down to the bottom, pop to the top of the next column to the left and repeat. TFBM_LL_ROW Start lower-left, go across to the the right, go to the next row up left-most and repeat. TFBM_LL_COL Start lower-left, go up to the top, pop to the bottom of the next column to the right and repeat. TFBM_LR_ROW Start lower-right, go across to the the left, go to the next row up left-most and repeat. TFBM_LR_COL Start lower-right, go up to the top, pop to the bottom of the next column to the left and repeat. TFBM_RANDOM Randomly select the next image

Functions Detail

Pause Source code

native function Pause ( )
Pauses the movie.

Play Source code

native function Play ( )
Plays the movie and also unpauses.

SetCurrentFrame Source code

native function SetCurrentFrame ( int Row, int Col )
Sets the current frame of the 'movie'.

Stop Source code

native function Stop ( )
Stops movie playback.

Defaultproperties 

defaultproperties
{
   bLooping=True
   bAutoPlay=True
   HorizontalImages=1
   VerticalImages=1
   FrameRate=4.000000
   FrameTime=0.250000
   AddressX=TA_Clamp
   AddressY=TA_Clamp
   Name="Default__TextureFlipBook"
   ObjectArchetype=Texture2D'Engine.Default__Texture2D'
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:45.562 - Created with UnCodeX