Projector

Base class: SlcAwareDisplay

Properties

_drawReferencePoints : bool

_guiState : ProjectorGuiState

_preferredOutputMode : int

activeOutputMode : int (Read-Only)

antiAlias : int

Anti-aliasing technique - makes edges smoother, but reduces performance

autoSoftEdge : int

Allows you to turn off Dynamic Blend on individual projectors

autoSoftEdgeMembershipFunction : int

Dynamic Blend Membership Algorithm

autoSoftEdgeSnapshotted : int

Lock Dynamic Blend snapshot

barnDoorBottom : float

Bottom edge of Dynamic Blend barndoor; increase this to move the edge upwards

barnDoorLeft : float

Left edge of Dynamic Blend barndoor; increase this to move the edge rightwards

barnDoorRight : float

Right edge of Dynamic Blend barndoor; increase this to move the edge leftwards

barnDoorTop : float

Top edge of Dynamic Blend barndoor; increase this to move the edge downwards

blur_shadow : float

Masked object blur amount

colour : Colour

The colour of the projector frustum in the visualiser

config : ProjectorConfig

Open this to enter the quick-calibration interface

configAutoZClipping : bool

configLensShift : Vec2

configLensShiftInv : Vec2

configLookAt : Vec

configLookDistance : float

configManualZFar : float

configManualZNear : float

configPosition : Vec

configRadialDistortion : Vec

configRotation : Vec

configSkew : float

configTangentialDistortion : Vec2

configThrowRatio : float

configWarpGridSize : Int2

deformStack : DeformStack

disableAutoCalViewUpdate : bool

dseCutoffAngle : float

Dynamic Blend cutoff angle in degrees. It’s a threshold for the angle between the projector’s incidence ray and the normal vector at a pixel. Any angle equal or larger than this will lead to zero contribution from this projector for a given pixel. Default is 90 degrees.

dseExclude : List[Projector]

Specifies which projectors are included or excluded from this projector’s Dynamic Blend

dseExcludeList : List[Projector]

dseResolutionFactor : int

Resolution for calculating Dynamic Blend projector contributions. Higher resolutions improve the resulting blend mask, reducing some visual artifcats such as overspill. But this also increases the cost of calculating the blend. Projectors should use reduced resolutions if they are affected by frequent Dynamic Blend recalculations e.g. if they target moving surfaces. Default: 1/16th.

faceCullMode : int

Can optionally skip rendering faces with normals pointing away (back) or toward (front) the projector.

feather : float

Shrinks or grows screens in the projector’s view, to fix over-projection

fieldOfView : float (Read-Only)

gammaBias : float

Adjusts the estimate of this projector’s gamma relative to the Stage’s global Blend gamma

gridSize : float

Controls the spacing of grid lines in Grid output mode

gridThickness : float

Controls the thickness of grid lines in Grid output mode

guiState : ProjectorGuiState (Read-Only)

includeOrExclude : int

lets you either remove projectors from Dynamic Blend consideration, or forces Blend to use only a specific list of projectors

isActiveOutputModeNone : bool (Read-Only)

isAutoCalIntrinsicsUserEditable : bool (Read-Only)

isOutputNeededByGui : bool

lensDistortionMode : int

lightScattering : int

enables light scattering for this projector

lightScatteringshadows : int

enables light scattering shadows for this projector

lineupBitmap : DxTexture

Bitmap used as quickcal lineup cursor

lumens : float

Projector brightness, in ANSI Lumens. Affects visualiser only

mask_objects : List[Object]

List of objects that this projector should render as black

mask_resolution : int

Set shadow mask resolution

masking_scale : float

Shrinks or grows the mask objects in the projector’s view

outputBrightness : float

output brightness (lumens)

projectionMatrix : Mat (Read-Only)

render_mode : int

Switches the projector’s output for easier identification or testing

screens : List[Screen2]

List of screen surfaces that this projector should render. Other screens will not be visible in the projector.

shadows : int

enables shadows for this projector

simulatedShutterOpen : bool

stackedProjectors : List[Projector]

Variables

FixedModeNone : Final = 0

FixedModePosition : Final = 1

FixedModePositionAndRotation : Final = 3

FixedModeRotation : Final = 2

getSupportedOutputModeNames : Callable

getSupportedOutputModes : Callable

getSupportedRenderModeNames : Callable

Methods

addScreen(self, s: Screen2)

addStackedProjector(self, p: Projector)

clearWarpsAndMasks(self)

configSetFixedMode(self, mode: int)

editingConfig(self, onOff: bool)

editingProjector(self, onOff: bool)

hasFeedAssigned(self) -> bool

hasStackedProjectors(self) -> bool

isStackedProjector(self) -> bool

mainProjector(self) -> Projector

nScreens(self) -> int

onCloseConfigEditor(self)

onOpenConfigEditor(self)

onStackedProjectorsUpdated(self)

preferredOutputMode(self, mode: int)

removeScreen(self, s: Screen2)

renderMode(self, value: int)

renderStage(self, resolution: Int2, viewTarget: DxTexture)

updateStackingWarp(self)