Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Enlighten API 4.03 Documentation
Results will update as you type.
  • class Enlighten IUpdateManagerWorker
  • class Enlighten LightMethodSelector
  • class Enlighten LightTransportPixel
  • class Enlighten LightValue64
  • class Enlighten LightValueIterator
  • class Enlighten Line2D
  • class Enlighten LrbCpuTextureSampler
  • class Enlighten MaterialAlbedoSampler
  • class Enlighten MaterialComponentBuffer
  • class Enlighten MaterialEmissiveSampler
  • class Enlighten MaterialGuids
  • class Enlighten MaterialSampler
  • class Enlighten MaterialTransparencySampler
  • class Enlighten MergeGeometry
  • class Enlighten MergeGeometryCache
  • class Enlighten MergeMap
  • class Enlighten MergeProcessParams
  • class Enlighten MergeStats
  • class Enlighten MergeTriGroupParams
  • class Enlighten MultithreadCpuUpdateManager
  • class Enlighten MultithreadCpuWorker
  • class Enlighten MultithreadCpuWorkerCommon
  • class Enlighten NullGeometryTransparencySampler
  • class Enlighten NullMaterialEmissiveSampler
  • class Enlighten NullMaterialTransparencySampler
  • class Enlighten NullSampler
  • class Enlighten OctreeSearchResult
  • class Enlighten PackedDusterPoint
  • class Enlighten PipelineBoxSetProbeRegion
  • class Enlighten PipelineCubemap
  • class Enlighten PipelineError
  • class Enlighten PipelineExcludedInstance
  • class Enlighten PipelineGeom
  • class Enlighten PipelineGeometryProperties
  • class Enlighten PipelineGlobalParameters
  • class Enlighten PipelineInstanceParameters
  • class Enlighten PipelineMesh
  • class Enlighten PipelinePaths
  • class Enlighten PipelinePointSetProbeRegion
  • class Enlighten PipelineProbeVolume
  • class Enlighten PipelineProgressBase
  • class Enlighten PipelineRadiosityInstance
  • class Enlighten PipelineScene
  • class Enlighten PipelineTransform
  • class Enlighten PipelineUnlitInstance
  • class Enlighten PipelineVolumeProbeRegion
  • class Enlighten PointLight
  • class Enlighten PointProjection
  • class Enlighten PointProjectionOptions
  • class Enlighten PointProjectionScratchMem
  • class Enlighten PointProjectionSurface
  • class Enlighten PointProjectionVersion
  • class Enlighten PppiWorld
  • class Enlighten PrecompInputFace
  • class Enlighten PrecompInputInstance
  • class Enlighten PrecompInputVertex
  • class Enlighten PrecompMaterialInfo
  • class Enlighten PrecompMeshInstanceView
  • class Enlighten PrecompMeshProperties
  • class Enlighten PrecompOctreeNode
  • class Enlighten PrecompOctreeProbeKey
  • class Enlighten PrecomputedVisibilityData
  • class Enlighten PrecomputedVisibilityWorkspace
  • class Enlighten PrecomputeParameters
  • class Enlighten PrecomputePipeline
  • class Enlighten PrecompVoxelId
  • class Enlighten PrecompVoxelOctree
  • class Enlighten PrecompVoxelOctreePath
  • class Enlighten PrecompVoxelOctreeVolume
  • class Enlighten ProbeInterpolant
  • class Enlighten ProbeInterpolationTask
  • class Enlighten ProbeSetManagerOctree
  • class Enlighten ProbeSetOctreeNode
  • class Enlighten ProbeSetVirtualProbe
  • class Enlighten ProfileHistory
  • class Enlighten QuadIterator
  • class Enlighten QuadShader
  • class Enlighten QuickFlatClusterShader
  • class Enlighten QuickQuadShader
  • class Enlighten R9G9B9E5CpuTextureSampler
  • class Enlighten R11G11B10CpuTextureSampler
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten PipelineProgressBase

    This is the documentation for Enlighten.

    class Enlighten PipelineProgressBase

    Sept 09, 2025

    template<typename DerivedType>
    class Enlighten::PipelineProgressBase

        └>Geo::IGeoProgressProxy

    Implements Geo::IGeoProgressProxy::ReportError.

    Usage:

    1. Derive from this class: class MyPipelineProgress : public PipelineProgressBase<MyProgress>

    2. Declare any number of HandleError overloads, where T is the type of the error handled: void HandleError(const T&)

    3. Implement the remaining pure virtual members of Geo::IGeoProgressProxy.

    When an error is reported, the matching DerivedType::HandleError overload is invoked. If no matching DerivedType::HandleError overload is found, a generic error message is logged.

    Functions

    Name Description
    ~IGeoProgressProxy()

    Virtual destructor.

    ReportError(const GeoError &)

    Called when an error (or warning) is encountered by the task.

    SetProgressString(const char *)

    Called by progress tracked tasks to inform clients of the current (sub) task.

    SetProportionDone(float)

    Called when a further chunk of work has been performed on the current (sub) task.

    ShouldCancel()

    Request a cancel of the current task.


    virtual Geo::IGeoProgressProxy::~IGeoProgressProxy

    protected: virtual ~IGeoProgressProxy()

    Virtual destructor.


    virtual void Geo::IGeoProgressProxy::ReportError

    public: void ReportError
    (
        const GeoError & error
    )

    Called when an error (or warning) is encountered by the task.

    Details of the error can be found in the Error struct. The Error struct is valid only for the lifetime of the call to ReportError and cannot be copied.


    virtual void Geo::IGeoProgressProxy::SetProgressString

    public: void SetProgressString
    (
        const char * desc
    )

    Called by progress tracked tasks to inform clients of the current (sub) task.


    virtual void Geo::IGeoProgressProxy::SetProportionDone

    public: void SetProportionDone
    (
        float globalProgress
    )

    Called when a further chunk of work has been performed on the current (sub) task.

    Parameters
    [in] globalProgress

    The total percentage of work completed on this task [0,1].


    virtual bool Geo::IGeoProgressProxy::ShouldCancel

    public: bool ShouldCancel()

    Request a cancel of the current task.

    This function will be called periodically by progress tracked tasks. Use this opportunity to request a halt to the current task.

    , multiple selections available,
    {"serverDuration": 20, "requestCorrelationId": "9b6bcfc1f710408d8f3cc4c7aa009554"}