ToneOperator Class Reference

Class Description

Converts physically based values to RGB for filtering and display. The renderer calls the tone operator immediately after Mtl::Shade is called. A tone operator also balances physical and non-physical lighting by providing a scale relationship between them.

Inheritance diagram for ToneOperator:

Public Member Functions
def	CanInvert
def	GetActive
def	GetIndirectOnly
def	GetPhysicalUnit
def	GetProcessBackground
def	IsPhysicalSpace
def	RGBToScaled
def	ScaledToRGB
def	ScalePhysical
def	ScaleRGB
def	SetActive
def	SetIndirectOnly
def	SetPhysicalUnit
def	SetProcessBackground
def	Update
Public Member Functions inherited from SpecialFX
def	Active
def	AppendGizmo
def	DeleteGizmo
def	EditGizmo
def	GetGizmo
def	GetName
def	GetNumGizmos
def	GetSpecialFXName
def	InsertGizmo
def	OKGizmo
def	SetSpecialFXName
def	Update
Public Member Functions inherited from ReferenceTarget
def	NotifyTarget
Public Member Functions inherited from ReferenceMaker
def	ClearFlagInHierarchy
def	DeleteMe
def	DeleteReference
def	FindRef
def	GetNumRefs
def	GetReference
def	NotifyChanged
def	NotifyDependents
def	ReplaceReference
def	RescaleWorldUnits
Public Member Functions inherited from Animatable
def	AddNewKey
def	AssignController
def	CanAssignController
def	CanCopyAnim
def	CanCopyTrack
def	CanDeleteSubAnim
def	CanMakeUnique
def	ClearAFlag
def	ClearAFlagEx
def	ClearFlagBit
def	ClearFlagInAllAnimatables
def	CopyKeysFromTime
def	DeleteKeyAtTime
def	DeleteKeyByIndex
def	DeleteKeys
def	DeleteSubAnim
def	DeleteTime
def	DoesSupportTimeOperations
def	EditTimeRange
def	FreeCaches
def	GetAnimByHandle
def	GetAnimHandle
def	GetClassID
def	GetClassName
def	GetCustomAttributeContainer
def	GetHasSubElements
def	GetKeyIndex
def	GetKeyTime
def	GetNextKeyTime
def	GetNodeName
def	GetNumKeys
def	GetNumSubAnims
def	GetParameterBlock
def	GetSubAnim
def	GetSubAnimName
def	GetSuperClassID
def	GetTimeRange
def	InsertTime
def	IsAnimated
def	IsKeyAtTime
def	IsSubClassOf
def	MoveKeys
def	ReverseTime
def	ScaleKeyValues
def	ScaleTime
def	SetAFlag
def	SetAFlagEx
def	SetFlagBit
def	SubNumToRefNum
def	TestAFlag
def	TestAFlagEx
def	TestFlagBit
Public Member Functions inherited from InterfaceServer
def	GetInterface
Public Member Functions inherited from Wrapper
def	GetUnwrappedPtr

Static Public Attributes
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from SpecialFX
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from ReferenceTarget
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from ReferenceMaker
tuple	NumRefs = _swig_property(GetNumRefs)
tuple	Refs = _swig_property(lambda self: (self.GetReference(i) for i in xrange(self.GetNumRefs())))
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from Animatable
tuple	AnimHandle = _swig_property(GetAnimHandle)
tuple	ClassID = _swig_property(GetClassID)
tuple	ClearFlagInAllAnimatables = staticmethod(ClearFlagInAllAnimatables)
tuple	GetAnimByHandle = staticmethod(GetAnimByHandle)
tuple	KeyTimes = _swig_property(lambda self: (self.GetKeyTime(i) for i in xrange(self.GetNumKeys())))
tuple	NodeName = _swig_property(GetNodeName)
tuple	NumSubAnims = _swig_property(GetNumSubAnims)
tuple	ParameterBlock = _swig_property(GetParameterBlock)
tuple	SubAnimNames = _swig_property(lambda self: (self.GetSubAnimName(i) for i in xrange(self.GetNumSubAnims())))
tuple	SubAnims = _swig_property(lambda self: (self.GetSubAnim(i) for i in xrange(self.GetNumSubAnims())))
tuple	SuperClassID = _swig_property(GetSuperClassID)
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from InterfaceServer
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from Wrapper
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Member Function Documentation

def CanInvert

(

self

)

CanInvert(ToneOperator self) -> bool

def GetActive	(		self,
			args
	)

GetActive(ToneOperator self, TimeValue t) -> bool

def GetIndirectOnly

(

self

)

GetIndirectOnly(ToneOperator self) -> bool

def GetPhysicalUnit	(		self,
			args
	)

GetPhysicalUnit(ToneOperator self, TimeValue t, Interval valid=Autodesk::Max::Interval(0, 0)) -> float
GetPhysicalUnit(ToneOperator self, TimeValue t) -> float

def GetProcessBackground

(

self

)

GetProcessBackground(ToneOperator self) -> bool

def IsPhysicalSpace

(

self

)

IsPhysicalSpace(ToneOperator self) -> bool

def RGBToScaled	(		self,
			args
	)

RGBToScaled(ToneOperator self, float energy) -> float

def ScaledToRGB	(		self,
			args
	)

ScaledToRGB(ToneOperator self, float energy) -> float

def ScalePhysical	(		self,
			args
	)

ScalePhysical(ToneOperator self, float energy) -> float

def ScaleRGB	(		self,
			args
	)

ScaleRGB(ToneOperator self, float color) -> float

def SetActive	(		self,
			args
	)

SetActive(ToneOperator self, bool active, TimeValue t)

def SetIndirectOnly	(		self,
			args
	)

SetIndirectOnly(ToneOperator self, bool active)

def SetPhysicalUnit	(		self,
			args
	)

SetPhysicalUnit(ToneOperator self, float value, TimeValue t)

def SetProcessBackground	(		self,
			args
	)

SetProcessBackground(ToneOperator self, bool active)

def Update	(		self,
			args
	)

Update(ToneOperator self, Interval valid, TimeValue t=Autodesk::Max::Now())
Update(ToneOperator self, Interval valid)