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

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 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)