OpenMayaRender.MSwatchRenderBase Class Reference

Inheritance diagram for OpenMayaRender.MSwatchRenderBase:

Public Member Functions
def	__init__ ()
def	cancelParallelRendering ()
def	doIteration ()
def	finishParallelRender ()
def	image ()
def	node ()
def	renderParallel ()
def	resolution ()
def	swatchNode ()

Static Public Member Functions
def	__new__ ()
def	cancelCurrentSwatchRender ()

Properties
	renderQuality = property(...)

Detailed Description

Swatch Render Base class.

Constructor & Destructor Documentation

def OpenMayaRender.MSwatchRenderBase.__init__

(

)

Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaRender.MSwatchRenderBase.__new__ ( )

static

Create and return a new object.  See help(type) for accurate signature.

def OpenMayaRender.MSwatchRenderBase.cancelCurrentSwatchRender ( )

static

cancelCurrentSwatchRender() -> None

The method cancels the swatch which is being rendered in parallel, and push the swatch render item back to the render queue after. 

The render plugins should make sure that MSwatchRenderBase.cancelParallelRendering() is implemented acoordingly.

def OpenMayaRender.MSwatchRenderBase.cancelParallelRendering

(

)

cancelParallelRendering() -> self

Method to cancel the parallel rendering.
The derived classes should provide the implementation accordingly if required.

def OpenMayaRender.MSwatchRenderBase.doIteration

(

)

doIteration() -> bool

Method called from the MSwatchRenderRegister for generation of swatch image. The doIteration function is called repeatedly (during idle events) until it returns true. Using this swatch image can be generated in stages.

This method should be overridden in derived classes which can compute the swatches in several steps.

Returns False as long as the swatch computation is not completed.

def OpenMayaRender.MSwatchRenderBase.finishParallelRender

(

)

finishParallelRender() -> self

Method to update the swatch image when the parallel rendering is finished.
If swatch is rendered parallel, this method must be called after parallel rendering finished.

def OpenMayaRender.MSwatchRenderBase.image

(

)

image() -> MImage

This method returns the render swatch as an image.

def OpenMayaRender.MSwatchRenderBase.node

(

)

node() -> MObject

This method returns the node that is used to compute the swatch.

def OpenMayaRender.MSwatchRenderBase.renderParallel

(

)

renderParallel() -> bool

Method indicates if the swatch is rendered parallel.
Default is False.

def OpenMayaRender.MSwatchRenderBase.resolution

(

)

resolution() -> int

This method returns the expected resolution of the swatch.

def OpenMayaRender.MSwatchRenderBase.swatchNode

(

)

swatchNode() -> MObject

This method returns the node for which the swatch is required to be generated.

Property Documentation

OpenMayaRender.MSwatchRenderBase.renderQuality = property(...)

static

 The quality in which the swatch will be rendered (the larger the number is set, the better quality is applied).