The IShadowCamera graph node interface.
More...
#include "murl_graph_i_shadow_camera.h"
The IShadowCamera graph node interface.
◆ GetNodeInterface() [1/2]
| virtual INode* Murl::Graph::IShadowCamera::GetNodeInterface |
( |
| ) |
|
|
pure virtual |
Get the mutable Graph::INode interface.
This method returns a mutable pointer to the node's Graph::INode interface, to be able to query or modify common node properties such as active state, visibility or ID.
- Returns
- The mutable Graph::INode interface, or null if not available
◆ GetNodeInterface() [2/2]
| virtual const INode* Murl::Graph::IShadowCamera::GetNodeInterface |
( |
| ) |
const |
|
pure virtual |
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.
- Returns
- The constant Graph::INode interface, or null if not available
◆ GetSubjectInterface() [1/2]
| virtual ISubject* Murl::Graph::IShadowCamera::GetSubjectInterface |
( |
| ) |
|
|
pure virtual |
Get the mutable ISubject interface.
This method returns a mutable pointer to the node's ISubject interface, to be able to query or modify subject properties such as world transform, viewing matrix, projection matrix etc.
- Returns
- The mutable ISubject interface, or null if not available
◆ GetSubjectInterface() [2/2]
| virtual const ISubject* Murl::Graph::IShadowCamera::GetSubjectInterface |
( |
| ) |
const |
|
pure virtual |
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.
- Returns
- The mutable ISubject interface, or null if not available
◆ GetCameraInterface() [1/2]
| virtual ICamera* Murl::Graph::IShadowCamera::GetCameraInterface |
( |
| ) |
|
|
pure virtual |
Get the mutable ICamera interface.
This method returns a mutable pointer to the node's ICamera interface, to be able to query or modify common camera parameters.
- Returns
- The mutable ICamera interface, or null if not available
◆ GetCameraInterface() [2/2]
| virtual const ICamera* Murl::Graph::IShadowCamera::GetCameraInterface |
( |
| ) |
const |
|
pure virtual |
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.
- Returns
- The mutable ICamera interface, or null if not available
◆ GetLightNodeTarget() [1/2]
Get the mutable container holding the light node casting the shadow.
This method returns a mutable pointer to the node's Graph::ILightNodeTarget container, which is used to store the light node.
- Returns
- The mutable Graph::ILightNodeTarget container, or null if not available.
◆ GetLightNodeTarget() [2/2]
| virtual const ILightNodeTarget* Murl::Graph::IShadowCamera::GetLightNodeTarget |
( |
| ) |
const |
|
pure virtual |
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.
- Returns
- The constant Graph::ILightNodeTarget container, or null if not available.
◆ GetCameraNodeTarget() [1/2]
Get the mutable container holding the camera node rendering the shadowed scene.
This method returns a mutable pointer to the node's Graph::ICameraNodeTarget container, which is used to store the scene camera node.
- Returns
- The mutable Graph::ICameraNodeTarget container, or null if not available.
◆ GetCameraNodeTarget() [2/2]
| virtual const ICameraNodeTarget* Murl::Graph::IShadowCamera::GetCameraNodeTarget |
( |
| ) |
const |
|
pure virtual |
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.
- Returns
- The constant Graph::ICameraNodeTarget container, or null if not available.
◆ SetPlacementMode()
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.
- Parameters
-
- Returns
- true if successful.
◆ GetPlacementMode()
Get the shadow map placement mode.
- Returns
- The placement mode.
◆ SetAlignmentMode()
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().
- Parameters
-
- Returns
- true if successful.
◆ GetAlignmentMode()
Get the shadow map alignment mode.
- Returns
- The alignment mode.
◆ SetUpVector()
| virtual Bool Murl::Graph::IShadowCamera::SetUpVector |
( |
const Vector & |
upVector | ) |
|
|
pure virtual |
◆ GetUpVector()
| virtual const Vector& Murl::Graph::IShadowCamera::GetUpVector |
( |
| ) |
const |
|
pure virtual |
Get the alignment plane's up vector.
- Returns
- The up vector.
◆ SetStabilizationEnabled()
| virtual Bool Murl::Graph::IShadowCamera::SetStabilizationEnabled |
( |
Bool |
enabled | ) |
|
|
pure virtual |
Enable/disable shadow map stabilization.
- Parameters
-
| enabled | If true, stabilization is enabled. |
- Returns
- true if successful.
◆ IsStabilizationEnabled()
| virtual Bool Murl::Graph::IShadowCamera::IsStabilizationEnabled |
( |
| ) |
const |
|
pure virtual |
Check if shadow map stabilization is enabled.
- Returns
- true if enabled.
◆ SetSphereScaleFactor()
| virtual Bool Murl::Graph::IShadowCamera::SetSphereScaleFactor |
( |
Real |
scaleFactor | ) |
|
|
pure virtual |
Set the bounding volume's additonal scale factor.
By default, the scale factor is set to 1.
- Parameters
-
| scaleFactor | The scale factor. |
- Returns
- true if successful.
◆ GetSphereScaleFactor()
| virtual Real Murl::Graph::IShadowCamera::GetSphereScaleFactor |
( |
| ) |
const |
|
pure virtual |
Get the bounding volume's additonal scale factor.
- Returns
- The scale factor.
The documentation for this interface was generated from the following file:
- murl_graph_i_shadow_camera.h
