ViewportsBackground Class Reference

Class Description

Utility functions for working with the backgrounds of viewports.

Inheritance diagram for ViewportsBackground:

Public Member Functions
def	GetColor
def	GetColorController
def	GetFrameNumber
def	GetFrameRange
def	GetImageAnimate
def	GetImageAspect
def	GetImageAsset
def	GetOutOfRangeType
def	GetStartTime
def	GetSyncFrame
def	SetColor
def	SetColorController
def	SetFrameRange
def	SetImageAnimate
def	SetImageAspect
def	SetImageAsset
def	SetOutOfRangeType
def	SetStartTime
def	SetSyncFrame

Static Public Attributes
tuple	GetColor = staticmethod(GetColor)
tuple	GetColorController = staticmethod(GetColorController)
tuple	GetFrameNumber = staticmethod(GetFrameNumber)
tuple	GetFrameRange = staticmethod(GetFrameRange)
tuple	GetImageAnimate = staticmethod(GetImageAnimate)
tuple	GetImageAspect = staticmethod(GetImageAspect)
tuple	GetImageAsset = staticmethod(GetImageAsset)
tuple	GetOutOfRangeType = staticmethod(GetOutOfRangeType)
tuple	GetStartTime = staticmethod(GetStartTime)
tuple	GetSyncFrame = staticmethod(GetSyncFrame)
tuple	SetColor = staticmethod(SetColor)
tuple	SetColorController = staticmethod(SetColorController)
tuple	SetFrameRange = staticmethod(SetFrameRange)
tuple	SetImageAnimate = staticmethod(SetImageAnimate)
tuple	SetImageAspect = staticmethod(SetImageAspect)
tuple	SetImageAsset = staticmethod(SetImageAsset)
tuple	SetOutOfRangeType = staticmethod(SetOutOfRangeType)
tuple	SetStartTime = staticmethod(SetStartTime)
tuple	SetSyncFrame = staticmethod(SetSyncFrame)
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Member Function Documentation

def GetColor

(

args

)

GetColor(TimeValue t, Interval valid) -> Point3
GetColor() -> Point3

def GetColorController

(

)

GetColorController() -> Control

def GetFrameNumber

(

args

)

GetFrameNumber(TimeValue t) -> int

def GetFrameRange

(

args

)

GetFrameRange(int which) -> int

def GetImageAnimate

(

)

GetImageAnimate() -> bool

def GetImageAspect

(

)

GetImageAspect() -> int

def GetImageAsset

(

)

GetImageAsset() -> Asset

def GetOutOfRangeType

(

args

)

GetOutOfRangeType(int which) -> int

def GetStartTime

(

)

GetStartTime() -> TimeValue

def GetSyncFrame

(

)

GetSyncFrame() -> int

def SetColor

(

args

)

SetColor(TimeValue t, Point3 color)
SetColor(Point3 color)

def SetColorController

(

args

)

SetColorController(Control c)

def SetFrameRange

(

args

)

SetFrameRange(int start, int end, int step=1)
SetFrameRange(int start, int end)

def SetImageAnimate

(

args

)

SetImageAnimate(bool onOff)

def SetImageAspect

(

args

)

SetImageAspect(int t)

def SetImageAsset

(

args

)

SetImageAsset(Asset asset) -> bool

def SetOutOfRangeType

(

args

)

SetOutOfRangeType(int which, int type)

def SetStartTime

(

args

)

SetStartTime(TimeValue t)

def SetSyncFrame

(

args

)

SetSyncFrame(int f)