Murl Engine Lua Addon API  Version 1.0 beta
Murl.Graph.IShadowCamera

The IShadowCamera graph node interface.


Table members

Methods


GetNodeInterface()

Get the constant Graph::INode interface. This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.

Murl.Graph.INode GetNodeInterface()

Returns
Murl.Graph.INode The constant Graph::INode interface, or null if not available

GetSubjectInterface()

Get the constant ISubject interface. This method returns a constant pointer to the node's ISubject interface, to be able to query subject properties such as world transform, viewing matrix, projection matrix etc.

Murl.Graph.ISubject GetSubjectInterface()

Returns
Murl.Graph.ISubject The mutable ISubject interface, or null if not available

GetCameraInterface()

Get the constant ICamera interface. This method returns a constant pointer to the node's ICamera interface, to be able to query common camera parameters.

Murl.Graph.ICamera GetCameraInterface()

Returns
Murl.Graph.ICamera The mutable ICamera interface, or null if not available

GetLightNodeTarget()

Get the constant container holding the light node casting the shadow. This method returns a constant pointer to the node's Graph::ILightNodeTarget container, which is used to store the light node.

Murl.Graph.IGenericNodeTarget.GraphILight GetLightNodeTarget()

Returns
Murl.Graph.IGenericNodeTarget.GraphILight The constant Graph::ILightNodeTarget container, or null if not available.

GetCameraNodeTarget()

Get the constant container holding the camera node rendering the shadowed scene. This method returns a constant pointer to the node's Graph::ILightNodeTarget container, which is used to store the scene camera node.

Murl.Graph.IGenericNodeTarget.GraphICamera GetCameraNodeTarget()

Returns
Murl.Graph.IGenericNodeTarget.GraphICamera The constant Graph::ICameraNodeTarget container, or null if not available.

SetPlacementMode(mode)

Set the shadow map placement mode. This method sets the placement mode for the shadow map, either at the view volume's actual center, or at the center of the bounding sphere surrounding the view volume.

Boolean SetPlacementMode(Murl.IEnums.ShadowMapPlacementMode mode)

Parameters
modeThe placement mode.
Returns
Boolean true if successful.

GetPlacementMode()

Get the shadow map placement mode.

Murl.IEnums.ShadowMapPlacementMode GetPlacementMode()

Returns
Murl.IEnums.ShadowMapPlacementMode The placement mode.

SetAlignmentMode(mode)

Set the shadow map alignment mode. This method sets the alignment mode for the shadow map, either perpendicular to the view vector (i.e. the light's main direction), or perpendicular to a given up vector defining a custom plane. See SetUpVector().

Boolean SetAlignmentMode(Murl.IEnums.ShadowMapAlignmentMode mode)

Parameters
modeThe alignment mode.
Returns
Boolean true if successful.

GetAlignmentMode()

Get the shadow map alignment mode.

Murl.IEnums.ShadowMapAlignmentMode GetAlignmentMode()

Returns
Murl.IEnums.ShadowMapAlignmentMode The alignment mode.

SetUpVector(upVector)

Set the alignment plane's up vector. The alignment plane's up vector is only used when the actual alignment mode is set to IEnums::SHADOW_MAP_ALIGNMENT_MODE_FIXED_PLANE. See SetAlignmentMode();

Boolean SetUpVector(Murl.Math.Vector upVector)

Parameters
upVectorThe up vector.
Returns
Boolean true if successful.

GetUpVector()

Get the alignment plane's up vector.

Murl.Math.Vector GetUpVector()

Returns
Murl.Math.Vector The up vector.

SetStabilizationEnabled(enabled)

Enable/disable shadow map stabilization.

Boolean SetStabilizationEnabled(Boolean enabled)

Parameters
enabledIf true, stabilization is enabled.
Returns
Boolean true if successful.

IsStabilizationEnabled()

Check if shadow map stabilization is enabled.

Boolean IsStabilizationEnabled()

Returns
Boolean true if enabled.

SetSphereScaleFactor(scaleFactor)

Set the bounding volume's additonal scale factor. By default, the scale factor is set to 1.

Boolean SetSphereScaleFactor(Number scaleFactor)

Parameters
scaleFactorThe scale factor.
Returns
Boolean true if successful.

GetSphereScaleFactor()

Get the bounding volume's additonal scale factor.

Number GetSphereScaleFactor()

Returns
Number The scale factor.