class CameraCoverageTool
The CameraCoverageTool consumes a scene together with a CameraCoverageSettings object and computes camera coverage information for the scene. The resulting data can be used by downstream processors such as visibility, impostor selection or LOD assignment.
Properties
| Property | Description |
|---|---|
| DestinationCamera | The destination scene camera that will receive the camera coverage views produced by the tool. The destination camera is not added to the input scene; it is populated by RunProcessing() and can be inspected, exported, or added to any scene by the caller. Each view written into the camera's parallel CameraPositions / TargetPositions / RenderUpVectors / RenderFOVs / RenderClippingPlanes arrays represents one camera produced by the coverage analysis. When EnableBackfaceFiltering is enabled, the destination camera is populated only with accepted views in the original candidate order and can be empty if no candidate is accepted. |
| Name | The name of the CameraCoverageTool object. (Inherited from Object) |
| Scene | The scene to compute camera coverage for. |
Methods
| Method | Description |
|---|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| Clear | Clear all internal states of the object. This will NOT clear the parameters set in the object. (Inherited from ProcessingObject) |
| GetCameraCoverageSettings | The settings object for the camera coverage tool. |
| GetClass | Get the name of the CameraCoverageTool class. (Inherited from Object) |
| GetPercentDone | Returns the current progress of the processing as a value between 0 and 100. (Inherited from ProcessingObject) |
| GetRejectedCameraCount | Returns the number of candidate views omitted by back-face filtering in the latest run, including candidates rejected because their renders contain no subject pixels. The count is zero before the first run, resets before every run and remains zero when back-face filtering is disabled. |
| IsA | Returns true if CameraCoverageTool is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the CameraCoverageTool object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the CameraCoverageTool object is valid. (Inherited from Object) |
| NonNull | Returns true if the CameraCoverageTool object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the CameraCoverageTool object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| RunProcessing | Runs the processing the object is designed for. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned. (Inherited from ProcessingObject) |
| ToJSON | Get settings as JSON for debugging purposes. (Inherited from ProcessingObject) |
Static methods
| Method | Description |
|---|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spCameraCoverageTool, and if this is the case, returns the object cast into spCameraCoverageTool. (Inherited from Object) |
Properties details
DestinationCamera
The destination scene camera that will receive the camera coverage views produced by the tool. The destination camera is not added to the input scene; it is populated by RunProcessing() and can be inspected, exported, or added to any scene by the caller. Each view written into the camera's parallel CameraPositions / TargetPositions / RenderUpVectors / RenderFOVs / RenderClippingPlanes arrays represents one camera produced by the coverage analysis. When EnableBackfaceFiltering is enabled, the destination camera is populated only with accepted views in the original candidate order and can be empty if no candidate is accepted.
Name
The name of the CameraCoverageTool object. (Inherited from Object)
Scene
The scene to compute camera coverage for.
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Clear
Clear all internal states of the object. This will NOT clear the parameters set in the object.
GetCameraCoverageSettings
The settings object for the camera coverage tool.
GetClass
Get the name of the CameraCoverageTool class. (Inherited from Object)
GetPercentDone
Returns the current progress of the processing as a value between 0 and 100.
GetRejectedCameraCount
Returns the number of candidate views omitted by back-face filtering in the latest run, including candidates rejected because their renders contain no subject pixels. The count is zero before the first run, resets before every run and remains zero when back-face filtering is disabled.
IsA
Returns true if CameraCoverageTool is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull
Returns true if the CameraCoverageTool object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the CameraCoverageTool object is valid. (Inherited from Object)
NonNull
Returns true if the CameraCoverageTool object is valid. (Inherited from Object)
PrintInfo
Prints the content/info of the CameraCoverageTool object to the log. (Inherited from Object)
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
RunProcessing
Runs the processing the object is designed for. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned.
ToJSON
Get settings as JSON for debugging purposes.
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spCameraCoverageTool, and if this is the case, returns the object cast into spCameraCoverageTool. (Inherited from Object)