Scene Info

class lwsdk.LWSceneInfo(self)

Bases: object

Proxy of C++ PCore::LWSceneInfo class

 RGBPrefix → char

The current RGB file saving prefix.

 adaptiveSampling → int

Boolean value that indicates if Adaptive Sampling is enabled. 1=enabled, 0=disabled.

 adaptiveThreshold → float

This contains the adaptive sampling threshold and is only valid when adaptiveSampling is enabled.

 alphaPrefix → char

The current RGB file saving prefix.

 animFilename → char

The name of the current animation file.

 animationPass → int

Plug-ins involved in animation or mesh deformation may be called multiple times during an animation calculation, even on the same frame. The animation pass gives some information about which pass the plug-in is being called. The value is one of:

  lwsdk.LWANIMPASS_MAIN
    The default value when none other applies
  lwsdk.LWANIMPASS_PRELIMINARY
    A preliminary pass, typically using speed over correctness when in preview
  lwsdk.LWANIMPASS_BLUR
    Animation evaluation pass used for motion blur calculations
  lwsdk.LWANIMPASS_RESTORE
    A pass to restore the animation state to the main state (typically after a blur pass)

 antialiasing → int

Current antialiasing setting, where zero (0) is off, or a value between 1 and 4 to indicate increasing antialiasing types.

LW8.2+: current antialiasing setting 0=off, 1-lowest, increasing for higher values (currently up to 4=extreme), 100 to 114; use PLD (with level 1 being 100 and level 15 being 114).

 buffersInUse → int

!! NOT IMPLEMENTED !!

 calculateallnormals → int

This flag returns the state of the CalculateAllNormals command that forces the calculation of normals, in Layout or while rendering.

 causticsAccuracy → int

The accuracy of the caustic illumination.

 causticsIntensity → double

Scales the intensity of the caustic illumination.

 causticsSoftness → int

The softness of the caustic illumination.

 dblSidedAreaLights → int

Current setting for double sided area lights. on/off.

 dynamicsRangeMax → double

Dynamic range maximum value, typically 1.

 dynamicsRangeMin → double

Dynamic range minimum value, typically 0.

 enableLenseFlares → int

This flag returns the state of the lense flare enable boolean.

 enhancedAA → int

Boolean value that indicates if Enhanced AA is enabled. 1=enabled, 0=disabled.

 filename → char

Filename of the scene file.

 filter → int

Current Soft Filter setting. A value of zero (0) indicates no filter, while a value of one (1) indicate Soft Filter is enabled.

LW8.2+:
  bit 0:
    0=no filter
    1=soft filter
  bits 1-5: indicate reconstruction filter:
    1-3=box(std,sharp,soft)
    4-6=Gaussian(std,sharp,soft)
    7-9=Mitchell(std,sharp,soft)
    10-12=Lanczos(std,sharp,soft)

 frameEnd → LWFrame

The number of the last frame defined for the scene. This is part of the rendering limits, not to be confused with the limits set by the user for previews (which you can get from the Interface Info global).

 frameHeight → int

Rendered image height, in pixels.

 frameStart → LWFrame

The number of the first frame defined for the scene. This is part of the rendering limits, not to be confused with the limits set by the user for previews (which you can get from the Interface Info global).

 frameStep → LWFrame

The step size, in frames, during rendering (the user setting for the Frame Step).

 frameWidth → int

Rendered image width, in pixels.

 framesPerSecond → double

Number of frames per playback second. This will ordinarily be 24 for film, 30 for NTSC video and 25 for PAL video. Note that this is the number of frames, not fields.

 has_multithreaded_filters → int

All active pixel filters are capable of multi-threading.

 lenseFlareIntensity → double

This return the value of the lense flare intensity at the current time.

 lightsamples → unsigned int

!! NOT DOCUMENTED !!

 lightthreshold → float

!! NOT DOCUMENTED !!

 limitedRegion → int[4]

The extents of the limited region area, in pixels. The extents are given in the order x0, y0, x1, y1.

 loadInProgress → int

A value that indicates whether or not a scene load is currently in progress. Zero (0) means no scene loading is taking place, 1 means a scene load (fresh) is occuring, and 2 means that load-from-scene is bringing in new elements to the existing scene.

 maxSamplesPerPixel → int

Maximum limits on the number of samples per pixel in the final image. Because of different rendering techniques and adaptive sampling it is impossible to compute a precise number of antialiasing samples at any pixel, but this gives a range for the current rendering options.

 minSamplesPerPixel → int

Minimum limits on the number of samples per pixel in the final image. Because of different rendering techniques and adaptive sampling it is impossible to compute a precise number of antialiasing samples at any pixel, but this gives a range for the current rendering options.

 name → char

User's name for the scene.

 numPoints → int

Total number of points for all the objects in the scene.

 numPolygons → int

Total number of polygons for all the objects in the scene.

 numThreads → int

The number of threads of execution that will be used during rendering.

 pixelAspect → double

The aspect ratio of the pixels in the image, expressed as width/height. Values greater than 1.0 mean short wide pixels and values less than 1.0 mean tall thin pixels.

 pixelFilterForceMT → int

Defaults to 0 to use the pixel filter flags to determine multi-threaded compatibility. Set to 1 to force pixel filters to render multi-threaded.

 radiosityAngularTolerance → double

Defines the density of placement of radiosity samples for curved surfaces.

 radiosityFileName → char

Location on the disk where the radiosity cache file is stored.

 radiosityFlags → int

This is a combination of bits for different radiosity display flags. The bit flags are:

lwsdk.LWRDFLG_SHOW_NODES
lwsdk.LWRDFLG_SHOW_CELLS
lwsdk.LWRDFLG_SHOW_COLOR_CELLS
lwsdk.LWRDFLG_SHOW_SAMPLES
lwsdk.LWRDFLG_SHOW_MISSING_PREPROCESS_SAMPLES
lwsdk.LWRDFLG_SHOW_MISSING_RENDER_SAMPLES
lwsdk.LWRDFLG_SHOW_SECOND_BOUNCE
lwsdk.LWRDFLG_SHOW_BEHIND
lwsdk.LWRDFLG_USE_BUMPS

 radiosityIndirectBounceCount → int

Number of radiosity bounces.

 radiosityIntensity → double

Scales the intensity of the radiosity solution.

 radiosityMaximumPixelSpacing → double

Maximum spacing of radiosity samples between output resolution pixels.

 radiosityMinimumPixelSpacing → double

Minimum spacing of radiosity samples between output resolution pixels.

 radiosityMultiplier → double

Scales the output resolution of the camera internally to compute the GI at lower/higher resolution.

 radiosityRaysPerEvaluation1 → int

Number of primary rays cast per evaluation point. These are the rays cast by each primary evaluation point.

 radiosityRaysPerEvaluation2 → int

Number of secondary rays cast per primary ray. These inform the primary evaluation point with further shading details.

 radiosityType → int

This member can hold one of several values:

lwsdk.LWRT_BackDrop
  Throws rays in random distribution, if miss, used backdrop color.
lwsdk.LWRT_MonteCarlo
  Throws rays in a random distribution.
lwsdk.LWRT_FinalGather
  Final Gather implementation.

 rangeChannel → int

If LWSceneInfo::rangeType is lwsdk.LWRANGETYPE_KEYFRAME, then this will contain the index of the channel owned by LWSceneInfo::rangeObject from which keyframes will be read to determine the frames to be rendered. Otherwise, its value has no defined meaning.

 rangeFrames → char

If LWSceneInfo::rangeType is lwsdk.LWRANGETYPE_ARBITRARY, then this string will contain the values entered by the user (verbatim) to designate the frames to be rendered. Otherwise, it will be None.

 rangeObject → LWItemID

If LWSceneInfo::rangeType is lwsdk.LWRANGETYPE_KEYFRAME, then this will contain the item id of the scene object whose channel keyframes (indexed by LWSceneInfo::rangeChannel) will determine the frames to be rendered. Otherwise, it will be None.

 rangeType → int

The render range type. This will be one of the following:

lwsdk.LWRANGETYPE_SINGLE
  The existing LWSceneInfo::frameStart, LWSceneInfo::frameEnd and LWSceneInfo::frameStep values hold the render frame settings.
lwsdk.LWRANGETYPE_ARBITRARY
  LWSceneInfo::rangeFrames will represent the frames to be rendered.
lwsdk.LWRANGETYPE_KEYFRAME
  LWSceneInfo::rangeObject and LWSceneInfo::rangeChannel settings will contain relevant values.

 raycutoff → float

The scene ray cutoff value.

 recursionDepth → int

The maximum recursion depth for raytracing.

 renderCamera(LWTime time) → LWItemID

Returns the item ID of the camera that will render the frame at the specified time.

 renderOpts → int

This is a combination of bits for different rendering options. The bit flags are:

lwsdk.LWROPT_SHADOWTRACE
lwsdk.LWROPT_REFLECTTRACE
lwsdk.LWROPT_REFRACTTRACE
lwsdk.LWROPT_FIELDS
lwsdk.LWROPT_EVENFIELDS
lwsdk.LWROPT_MOTIONBLUR
lwsdk.LWROPT_DEPTHOFFIELD
lwsdk.LWROPT_LIMITEDREGION
lwsdk.LWROPT_PARTICLEBLUR
lwsdk.LWROPT_ENHANCEDAA
lwsdk.LWROPT_SAVEANIM
lwsdk.LWROPT_SAVERGB
lwsdk.LWROPT_SAVEALPHA
lwsdk.LWROPT_ZBUFFERAA
lwsdk.LWROPT_RTTRANSPARENCIES
lwsdk.LWROPT_RADIOSITY
lwsdk.LWROPT_CAUSTICS
lwsdk.LWROPT_OCCLUSION
lwsdk.LWROPT_RENDERLINES
lwsdk.LWROPT_INTERPOLATED
lwsdk.LWROPT_BLURBACKGROUND
lwsdk.LWROPT_USETRANSPARENCY
lwsdk.LWROPT_VOLUMETRICRADIOSITY
lwsdk.LWROPT_USEAMBIENT
lwsdk.LWROPT_DIRECTIONALRAYS
lwsdk.LWROPT_LIMITDYNAMICRANGE
lwsdk.LWROPT_CACHERADIOSITY
lwsdk.LWROPT_USEGRADIENTS
lwsdk.LWROPT_USEBEHINDTEST
lwsdk.LWROPT_CAUSTICSCACHE
lwsdk.LWROPT_RENDERINSTANCES
lwsdk.LWROPT_UNPREMULTIPLIEDALPHA

lwsdk.LWROPT_EVENFIELDS is set only if field rendering is on and the first line of the output image is from the field that comes first in time.

 renderType → int

The render type, which can be one of the following:

lwsdk.LWRTYPE_WIRE
lwsdk.LWRTYPE_QUICK
lwsdk.LWRTYPE_REALISTIC

 rendermode → int

Incicates which render mode the render was started in:

lwsdk.lwrm_None
lwsdk.lwrm_SceneBake
lwsdk.lwrm_Scene
lwsdk.lwrm_FrameBake
lwsdk.lwrm_Frame
lwsdk.lwrm_Inspire
lwsdk.lwrm_SelectedObject

 saturation → double

Color saturation of the rendered frame.

 shadingsamples → unsigned int

The scene shading samples.

 useZminmax → int

The z buffer has been pre-normalized to the LWSceneInfo::zmin (minimum) and LWSceneInfo::zmax (maximum) values.

 zmax → double

Pre-normalized maximum z value.

 zmin → double

Pre-normalized minimum z value.

Previous topic

Camera Evaluation Funcs

Next topic

Time Info

This Page