Module pylux :: Class Context

Class Context

 object --+    
          |    
??.instance --+
              |
             Context

An instance of a LuxRender rendering context

Instance Methods

[hide private]

__init__(...)
__init__( (object)Context, (str)name) -> None :...

__reduce__(...)
helper for pickle

accelerator(...)
accelerator( (Context)Context, (str)type, (list)ParamSet) -> None : Initialise geometry acceleration structure type.

addServer(...)
addServer( (Context)Context, (str)address) -> None :...

addThread(...)
addThread( (Context)Context) -> int :...

areaLightSource(...)
areaLightSource( (Context)Context, (str)type, (list)ParamSet) -> None : Attach a light source to the current geometry definition.

attributeBegin(...)
attributeBegin( (Context)Context) -> None : Begin a new Attribute scope, inheriting attributes from parent scope.

attributeEnd(...)
attributeEnd( (Context)Context) -> None : End an Attribute scope, reverting attributes to parent scope.

camera(...)
camera( (Context)Context, (str)type, (list)ParamSet) -> None : Add a camera to the scene.

cleanup(...)
cleanup( (Context)Context) -> None : Clean up and reset the renderer state after rendering.

concatTransform(...)
concatTransform( (Context)Context, (list)transform) -> None : Concatenate the given transformation onto the current transformation.

coordSysTransform(...)
coordSysTransform( (Context)Context, (str)name) -> None : Replaces the current transformation matrix with the matrix that forms the named coordinate system.

coordinateSystem(...)
coordinateSystem( (Context)Context, (str)name) -> None : This function marks the coordinate system defined by the current transformation with the name space and saves it.

disableRandomMode(...)
disableRandomMode( (Context)Context) -> None : Disables random mode in the renderer core.

enableDebugMode(...)
enableDebugMode( (Context)Context) -> None : Puts the renderer core into Debug mode.

exit(...)
exit( (Context)Context) -> None : Stop the current rendering.

exterior(...)
exterior( (Context)Context, (str)VolumeName) -> None : Sets the current Exterior volume shader.

film(...)
film( (Context)Context, (str)type, (list)ParamSet) -> None : Initialise the Film for rendering.

framebuffer(...)
framebuffer( (Context)Context) -> list : Returns the current post-processed LDR framebuffer in RGB888 format as a list.

getDefaultParameterValue(...)
getDefaultParameterValue( (Context)Context, (luxComponent)component, (luxComponentParameters)parameter, (int)index) -> float

getDefaultStringParameterValue(...)
getDefaultStringParameterValue( (Context)arg1, (luxComponent)arg2, (luxComponentParameters)arg3, (str)arg4, (int)arg5, (int)Context) -> int

getHistogramImage(...)
getHistogramImage( (Context)Context, (int)width, (int)height, (int)options) -> list

getNetworkServerUpdateInterval(...)
getNetworkServerUpdateInterval( (Context)Context) -> int

getOption(...)
getOption( (Context)arg1, (str)arg2, (str)Context) -> object

getOptions(...)
getOptions( (Context)Context) -> str

getParameterValue(...)
getParameterValue( (Context)Context, (luxComponent)component, (luxComponentParameters)parameter, (int)index) -> float

getRenderingServersStatus(...)
getRenderingServersStatus( (Context)Context, (RenderingServerInfo)ServerStatusObject, (int)index) -> int

getServerCount(...)
getServerCount( (Context)Context) -> int : Return the number of remote slaves contributing towards the current rendering.

getStringParameterValue(...)
getStringParameterValue( (Context)arg1, (luxComponent)arg2, (luxComponentParameters)arg3, (str)arg4, (int)arg5, (int)Context) -> int

identity(...)
identity( (Context)Context) -> None : Set the current transform to the identity matrix.

interior(...)
interior( (Context)Context, (str)VolumeName) -> None : Set the current Interior volume shader.

lightGroup(...)
lightGroup( (Context)Context, (str)name, (list)ParamSet) -> None : Change the named group of all following light sources in this scope.

lightSource(...)
lightSource( (Context)Context, (str)type, (list)ParamSet) -> None : Create a light source of the specified type.

loadFLM(...)
loadFLM( (Context)Context, (str)filename) -> None : Load an FLM film file into the context for tonemapping/post-processing purposes.

lookAt(...)
lookAt( (Context)Context, (float)pos0, (float)pos1, (float)pos2, (float)trg0, (float)trg1, (float)trg2, (float)up0, (float)up1, (float)up2) -> None : Specify the position, target and up vector of the scene's camera.

makeNamedMaterial(...)
makeNamedMaterial( (Context)Context, (str)name, (list)ParamSet) -> None : Define a named material with the given name and type.

makeNamedVolume(...)
makeNamedVolume( (Context)Context, (str)name, (str)type, (list)ParamSet) -> None : Define a named volume with the given name and type.

material(...)
material( (Context)Context, (str)type, (list)ParamSet) -> None : Define a material of the given type in the current scope.

motionInstance(...)
motionInstance( (Context)arg1, (str)arg2, (float)arg3, (float)arg4, (str)Context) -> None : Instantiates a moving object.

namedMaterial(...)
namedMaterial( (Context)Context, (str)name) -> None : Instantiate a named material in the current scope as if it were defined with material().

objectBegin(...)
objectBegin( (Context)Context, (str)name) -> None : Define a named object that can be re-used with objectInstance().

objectEnd(...)
objectEnd( (Context)Context) -> None : End a named object definition.

objectInstance(...)
objectInstance( (Context)Context, (str)name) -> None : Instatiate a named object defined within an objectBegin()/objectEnd() pair in the current scope.

overrideResumeFLM(...)
overrideResumeFLM( (Context)arg1, (str)Context) -> None

parse(...)
parse( (Context)Context, (str)filename, (bool)asynchronous) -> int : Parse the given filename.

pause(...)
pause( (Context)Context) -> None : (+) Pause all local rendering threads.

pixelFilter(...)
pixelFilter( (Context)Context, (str)type, (list)ParamSet) -> None : Initialise the pixel filter to use for rendering.

portalShape(...)
portalShape( (Context)Context, (str)type, (list)ParamSet) -> None : Define geometry as an "Exit Portal" shape.

removeServer(...)
removeServer( (Context)Context, (str)address) -> None : Remote a remote rendering slave from the current rendering process.

removeThread(...)
removeThread( (Context)Context) -> None : Remove a local rendering thread from the current rendering process.

reverseOrientation(...)
reverseOrientation( (Context)Context) -> None : Causes the orientation in the current scope to be reversed left->right or right->left handed.

rotate(...)
rotate( (Context)Context, (float)degrees, (float)x, (float)y, (float)z) -> None : Concatenate a rotation of the given angle, about the given axis onto the current scope's transformation.

sampler(...)
sampler( (Context)Context, (str)type, (list)ParaSet) -> None : Initialise the sampler to use for rendering.

saveFLM(...)
saveFLM( (Context)Context, (str)filename) -> None : Save the current virtual film to an FLM file.

scale(...)
scale( (Context)Context, (float)x, (float)y, (float)z) -> None : Concatenate a scaling onto the current scope's transformation.

setEpsilon(...)
setEpsilon( (Context)arg1, (float)arg2, (float)Context) -> None

setHaltSamplePerPixel(...)
setHaltSamplePerPixel( (Context)arg1, (int)arg2, (bool)arg3, (bool)Context) -> None

setNetworkServerUpdateInterval(...)
setNetworkServerUpdateInterval( (Context)arg1, (int)Context) -> None

setOption(...)
setOption( (Context)arg1, (str)arg2, (str)arg3, (object)Context) -> None

setParameterValue(...)
setParameterValue( (Context)arg1, (luxComponent)arg2, (luxComponentParameters)arg3, (float)arg4, (int)Context) -> None

setStringParameterValue(...)
setStringParameterValue( (Context)arg1, (luxComponent)arg2, (luxComponentParameters)arg3, (str)arg4, (int)Context) -> None

shape(...)
shape( (Context)Context, (str)type, (list)ParamSet) -> None : Define a geometry primitive in the current scope.

start(...)
start( (Context)Context) -> None :...

statistics(...)
statistics( (Context)Context, (str)name) -> float : Return the named statistic from the current rendering.

surfaceIntegrator(...)
surfaceIntegrator( (Context)Context, (str)type, (list)ParamSet) -> None : Initialise the surface integrator to use for rendering.

texture(...)
texture( (Context)Context, (str)name, (str)variant, (str)type, (list)ParamSet) -> None : Define a texture shader in the current scope.

transform(...)
transform( (Context)Context, (list)transform) -> None : Set the current scope's transformation matrix.

transformBegin(...)
transformBegin( (Context)Context) -> None : Begin a new transformation scope, inheriting the transform from the parent scope.

transformEnd(...)
transformEnd( (Context)Context) -> None : End the current transformation scope, reverting to the transformation of the parent scope.

translate(...)
translate( (Context)Context, (float)x, (float)y, (float)z) -> None : Concatenate a translation onto the current scope's transformation.

updateFilmFromNetwork(...)
updateFilmFromNetwork( (Context)Context) -> None : Update the current virtual film with contributions from attached network slaves.

updateFramebuffer(...)
updateFramebuffer( (Context)Context) -> None : Process the raw virtual film through the tonemapping post-processing pipeline into the LDR framebuffer.

volume(...)
volume( (Context)Context, (str)type, (list)ParamSet) -> None : Define a bound volume object for volumetric effects.

volumeIntegrator(...)
volumeIntegrator( (Context)Context, (str)type, (list)ParamSet) -> None : Initialise the volume integrator to use for rendering.

wait(...)
wait( (Context)Context) -> None : Wait for rendering threads to complete.

worldBegin(...)
worldBegin( (Context)Context) -> None : Specify that all rendering options shall be frozen, and that what commences is the description for the scene to be rendered.

worldEnd(...)
worldEnd( (Context)Context) -> None : Ends the current scene description and starts the rendering process asynchronously in a single local thread.

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

__instance_size__ = 48

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)


__init__( (object)Context, (str)name) -> None :
    Create a new rendering Context object with the given name

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

accelerator(...)


accelerator( (Context)Context, (str)type, (list)ParamSet) -> None :
    Initialise geometry acceleration structure type. Valid types are
    - bruteforce
    - bvh
    - grid
    - qbvh
    - tabreckdtree (or kdtree)

addServer(...)


addServer( (Context)Context, (str)address) -> None :
    Add a (remote) rendering server to the context

addThread(...)


addThread( (Context)Context) -> int :
    Add a local rendering thread to the context

areaLightSource(...)


areaLightSource( (Context)Context, (str)type, (list)ParamSet) -> None :
    Attach a light source to the current geometry definition. (See: RiSpec 3.2 p.43)

attributeBegin(...)


attributeBegin( (Context)Context) -> None :
    Begin a new Attribute scope, inheriting attributes from parent scope.
    (See: RiSpec 3.2 p.38)

attributeEnd(...)


attributeEnd( (Context)Context) -> None :
    End an Attribute scope, reverting attributes to parent scope.
    (See: RiSpec 3.2 p.38)

camera(...)


camera( (Context)Context, (str)type, (list)ParamSet) -> None :
    Add a camera to the scene. Valid types are:
    - environment
    - orthographic
    - perspective
    - realistic

concatTransform(...)


concatTransform( (Context)Context, (list)transform) -> None :
    Concatenate the given transformation onto the current transformation. The
    transformation is applied before all previously applied transformations, that
    is, before the current transformation. (Ref: RiSpec 3.2 p.56)

coordSysTransform(...)


coordSysTransform( (Context)Context, (str)name) -> None :
    Replaces the current transformation matrix with the matrix that forms the named
    coordinate system. This permits objects to be placed directly into special or
    user-defined coordinate systems by their names. (Ref: RiSpec 3.2 p.57)

coordinateSystem(...)


coordinateSystem( (Context)Context, (str)name) -> None :
    This function marks the coordinate system defined by the current transformation
    with the name space and saves it. (Ref: RiSpec 3.2 p.58)

exterior(...)


exterior( (Context)Context, (str)VolumeName) -> None :
    Sets the current Exterior volume shader. (Ref: RiSpec 3.2 p.48)

film(...)


film( (Context)Context, (str)type, (list)ParamSet) -> None :
    Initialise the Film for rendering. Valid types are:
    - fleximage.

framebuffer(...)


framebuffer( (Context)Context) -> list :
    Returns the current post-processed LDR framebuffer in RGB888 format as a list.
    It is advisable to call updateFramebuffer() before calling this function.

interior(...)


interior( (Context)Context, (str)VolumeName) -> None :
    Set the current Interior volume shader. (Ref: RiSpec 3.2 p.47)

lightSource(...)


lightSource( (Context)Context, (str)type, (list)ParamSet) -> None :
    Create a light source of the specified type. Valid types are:
    - area
    - distant
    - goniometric
    - infinite
    - point
    - projection
    - sky
    - sun
    - sunsky (shortcut for sun + sky)
    - spot

makeNamedMaterial(...)


makeNamedMaterial( (Context)Context, (str)name, (list)ParamSet) -> None :
    Define a named material with the given name and type. See also material().

makeNamedVolume(...)


makeNamedVolume( (Context)Context, (str)name, (str)type, (list)ParamSet) -> None :
    Define a named volume with the given name and type. Not to be confused with the
    volume() system.

material(...)


material( (Context)Context, (str)type, (list)ParamSet) -> None :
    Define a material of the given type in the current scope. Valid types are:
    - carpaint
    - glass
    - glass2
    - glossy_lossy
    - glossy
    - matte
    - mattetranslucent
    - metal
    - mirror
    - mix
    - null
    - roughglass
    - shinymetal

motionInstance(...)


motionInstance( (Context)arg1, (str)arg2, (float)arg3, (float)arg4, (str)Context) -> None :
    Instantiates a moving object. See also objectInstance(). (Sim.: RiSpec 3.2 p.96).

objectBegin(...)


objectBegin( (Context)Context, (str)name) -> None :
    Define a named object that can be re-used with objectInstance().
    (Ref: RiSpec 3.2 p.94).

objectInstance(...)


objectInstance( (Context)Context, (str)name) -> None :
    Instatiate a named object defined within an objectBegin()/objectEnd() pair in
    the current scope. (Ref: RiSpec 3.2 p.95)

parse(...)


parse( (Context)Context, (str)filename, (bool)asynchronous) -> int :
    Parse the given filename. If done asynchronously, control will pass
    immediately back to the python interpreter, otherwise this function blocks.

pixelFilter(...)


pixelFilter( (Context)Context, (str)type, (list)ParamSet) -> None :
    Initialise the pixel filter to use for rendering. Valid types are:
    - box
    - triangle
    - gaussian
    - mitchell
    - sinc

portalShape(...)


portalShape( (Context)Context, (str)type, (list)ParamSet) -> None :
    Define geometry as an "Exit Portal" shape. See shape().

reverseOrientation(...)


reverseOrientation( (Context)Context) -> None :
    Causes the orientation in the current scope to be reversed left->right or
    right->left handed. (Ref: RiSpec 3.2 p.53).

rotate(...)


rotate( (Context)Context, (float)degrees, (float)x, (float)y, (float)z) -> None :
    Concatenate a rotation of the given angle, about the given axis onto the current
    scope's transformation. (Ref: RiSpec 3.2 p.57)

sampler(...)


sampler( (Context)Context, (str)type, (list)ParaSet) -> None :
    Initialise the sampler to use for rendering. Valid types are:
    - random
    - lowdiscrepancy
    - metropolis
    - erpt

scale(...)


scale( (Context)Context, (float)x, (float)y, (float)z) -> None :
    Concatenate a scaling onto the current scope's transformation.
    (Ref: RiSpec 3.2 p.57)

shape(...)


shape( (Context)Context, (str)type, (list)ParamSet) -> None :
    Define a geometry primitive in the current scope. Valid types are:
    - cone
    - cylinder
    - disk
    - heightfield
    - lenscomponent
    - loopsubdiv
    - nurbs
    - paraboloid
    - plymesh
    - sphere
    - trianglemesh
    - mesh

start(...)


start( (Context)Context) -> None :
    (+) Re-start local rendering threads after a pause()

statistics(...)


statistics( (Context)Context, (str)name) -> float :
    Return the named statistic from the current rendering. Valid statistic names are:
    - sceneIsReady : returns truthy if the scene has been built and is ready for rendering
    - filmIsReady : ?
    - terminated : ?
    - secElapsed : number of seconds since the rendering started
    - samplesSec : current local rendering speed in samples per second
    - samplesTotSec : current average total rendering speed in samples per second
    - samplesPx : current number of samples per pixel
    - efficiency : current rendering efficiency in percent
    - filmXres : current film X resolution
    - filmYres : current film Y resolution
    - displayInterval : current framebuffer update/display interval in seconds
    - filmEV : current film Exposure Value
    - enoughSamples : returns truthy if the rendering has reached a haltspp condition

surfaceIntegrator(...)


surfaceIntegrator( (Context)Context, (str)type, (list)ParamSet) -> None :
    Initialise the surface integrator to use for rendering. Valid types are:
    - bidirectional
    - directlighting
    - exphotonmap
    - path
    - distributedpath

texture(...)


texture( (Context)Context, (str)name, (str)variant, (str)type, (list)ParamSet) -> None :
    Define a texture shader in the current scope. Valid types are:
    - bilerp
    - checkerboard
    - constant
    - dots
    - fbm
    - imagemap
    - marble
    - mix
    - scale
    - uv
    - windy
    - wrinkled
    Lux also supports the textures found in Blender, prefixed with the name "blender_":
    - blender_blend
    - blender_clouds
    - blender_distortednoise
    - blender_magic
    - blender_marble
    - blender_musgrave
    - blender_noise
    - blender_stucci
    - blender_voronoi
    - blender_wood

transform(...)


transform( (Context)Context, (list)transform) -> None :
    Set the current scope's transformation matrix. (Ref: RiSpec 3.2 p.56)

transformBegin(...)


transformBegin( (Context)Context) -> None :
    Begin a new transformation scope, inheriting the transform from the parent scope.
    (Ref: RiSpec 3.2 p.59).

transformEnd(...)


transformEnd( (Context)Context) -> None :
    End the current transformation scope, reverting to the transformation of the parent
    scope. (Ref: RiSpec 3.2 p.59).

translate(...)


translate( (Context)Context, (float)x, (float)y, (float)z) -> None :
    Concatenate a translation onto the current scope's transformation.
    (Ref: RiSpec 3.2 p.57)

updateFramebuffer(...)


updateFramebuffer( (Context)Context) -> None :
    Process the raw virtual film through the tonemapping post-processing pipeline
    into the LDR framebuffer. Results can be fetched with the frameBuffer() call.

volume(...)


volume( (Context)Context, (str)type, (list)ParamSet) -> None :
    Define a bound volume object for volumetric effects. Valid types are:
    - exponential
    - homogenous

volumeIntegrator(...)


volumeIntegrator( (Context)Context, (str)type, (list)ParamSet) -> None :
    Initialise the volume integrator to use for rendering. Valid types are:
    - emission
    - single

wait(...)


wait( (Context)Context) -> None :
    Wait for rendering threads to complete. Unless some halt condition is set, or
    the process is otherwise interrupted, expect to wait() forever.

worldBegin(...)


worldBegin( (Context)Context) -> None :
    Specify that all rendering options shall be frozen, and that what commences is
    the description for the scene to be rendered. (Ref: RiSpec 3.2 p.17)

worldEnd(...)


worldEnd( (Context)Context) -> None :
    Ends the current scene description and starts the rendering process asynchronously
    in a single local thread. (Ref: RiSpec 3.2 p.17)

Class Context

__init__(...) (Constructor)

__reduce__(...)

accelerator(...)

addServer(...)

addThread(...)

areaLightSource(...)

attributeBegin(...)

attributeEnd(...)

camera(...)

concatTransform(...)

coordSysTransform(...)

coordinateSystem(...)

exterior(...)

film(...)

framebuffer(...)

interior(...)

lightSource(...)

makeNamedMaterial(...)

makeNamedVolume(...)

material(...)

motionInstance(...)

objectBegin(...)

objectInstance(...)

parse(...)

pixelFilter(...)

portalShape(...)

reverseOrientation(...)

rotate(...)

sampler(...)

scale(...)

shape(...)

start(...)

statistics(...)

surfaceIntegrator(...)

texture(...)

transform(...)

transformBegin(...)

transformEnd(...)

translate(...)

updateFramebuffer(...)

volume(...)

volumeIntegrator(...)

wait(...)

worldBegin(...)

worldEnd(...)

init(...)
(Constructor)

reduce(...)