ToneOperator Class Reference

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)
Public Member Functions inherited from ReferenceTarget
def	FindDependentNode (self)
def	MaybeAutoDelete (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 (self, type=0)
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
	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
	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
	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
	NumRefs = _swig_property(GetNumRefs)
	Refs = _swig_property(lambda self: (self.GetReference(i) for i in xrange(self.GetNumRefs())))
	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
	AnimHandle = _swig_property(GetAnimHandle)
	ClassID = _swig_property(GetClassID)
	ClearFlagInAllAnimatables = staticmethod(ClearFlagInAllAnimatables)
	GetAnimByHandle = staticmethod(GetAnimByHandle)
	KeyTimes = _swig_property(lambda self: (self.GetKeyTime(i) for i in xrange(self.GetNumKeys())))
	NodeName = _swig_property(GetNodeName)
	NumSubAnims = _swig_property(GetNumSubAnims)
	ParameterBlock = _swig_property(GetParameterBlock)
	SubAnimNames = _swig_property(lambda self: (self.GetSubAnimName(i) for i in xrange(self.GetNumSubAnims())))
	SubAnims = _swig_property(lambda self: (self.GetSubAnim(i) for i in xrange(self.GetNumSubAnims())))
	SuperClassID = _swig_property(GetSuperClassID)
	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
	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
	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Detailed 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.

Member Function Documentation

CanInvert()

def CanInvert

(

self

)

CanInvert(ToneOperator self) -> bool

GetActive()

def GetActive	(		self,
		*	args
	)

GetActive(ToneOperator self, TimeValue t) -> bool

GetIndirectOnly()

def GetIndirectOnly

(

self

)

GetIndirectOnly(ToneOperator self) -> bool

GetPhysicalUnit()

def GetPhysicalUnit	(		self,
		*	args
	)

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

GetProcessBackground()

def GetProcessBackground

(

self

)

GetProcessBackground(ToneOperator self) -> bool

RGBToScaled()

def RGBToScaled	(		self,
		*	args
	)

RGBToScaled(ToneOperator self, float energy) -> float

ScaledToRGB()

def ScaledToRGB	(		self,
		*	args
	)

ScaledToRGB(ToneOperator self, float energy) -> float

ScalePhysical()

def ScalePhysical	(		self,
		*	args
	)

ScalePhysical(ToneOperator self, float energy) -> float

ScaleRGB()

def ScaleRGB	(		self,
		*	args
	)

ScaleRGB(ToneOperator self, float color) -> float

SetActive()

def SetActive	(		self,
		*	args
	)

SetActive(ToneOperator self, bool active, TimeValue t)

SetIndirectOnly()

def SetIndirectOnly	(		self,
		*	args
	)

SetIndirectOnly(ToneOperator self, bool active)

SetPhysicalUnit()

def SetPhysicalUnit	(		self,
		*	args
	)

SetPhysicalUnit(ToneOperator self, float value, TimeValue t)

SetProcessBackground()

def SetProcessBackground	(		self,
		*	args
	)

SetProcessBackground(ToneOperator self, bool active)

Update()

def Update	(		self,
		*	args
	)

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

Reimplemented from SpecialFX.