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 3.10 Documentation
Results will update as you type.
  • class Enlighten IBakeSolvedRuntime
  • class Enlighten IBakeSystemResource
  • class Enlighten IBakeTextureManager
  • class Enlighten IBakeVisibilityBuffer
  • class Enlighten IClusteringOutput
  • class Enlighten IGpuTexture
  • class Enlighten IGpuTextureAllocator
  • class Enlighten IGpuTextureUpdater
  • class Enlighten ILightTransportOutput
  • class Enlighten ILimiter
  • class Enlighten ILogHandler
  • class Enlighten IMeshSimpOutput
  • class Enlighten ImporterScene
  • class Enlighten IncidentLightingBuffer
  • class Enlighten IndirectInputLightingInternalParameters
  • class Enlighten IndirectInputLightingParameters
  • class Enlighten InputLightBase
  • class Enlighten InputLightFalloffTable
  • class Enlighten InputLightingBuffer
  • class Enlighten InputOctreeBuilder
  • class Enlighten InputTextureSamplerParameters
  • class Enlighten InputWorkspace
  • class Enlighten InputWorkspaceDebugIterator
  • class Enlighten InputWorkspaceDebugPoint
  • class Enlighten InputWorkspaceDynamicInternal
  • class Enlighten InputWorkspaceInternal
  • class Enlighten InputWorkspaceMetaData
  • class Enlighten InternalLightFalloffTable
  • class Enlighten InterpolatedPoint
  • class Enlighten InterpolationInputSet
  • class Enlighten IPppiTextureUpdateHandler
  • class Enlighten IPrecompBuildParameters
  • class Enlighten IPrecompCubeMapBuildParameters
  • class Enlighten IPrecompCubeMapCore
  • class Enlighten IPrecompDepthCubeMap
  • class Enlighten IPrecompGeneratedSystems
  • class Enlighten IPrecompInputCubeMap
  • class Enlighten IPrecompInputGeometry
  • class Enlighten IPrecompInputItemDependencies
  • class Enlighten IPrecompInputMesh
  • class Enlighten IPrecompInputProbeOctree
  • class Enlighten IPrecompInputProbeRegion
  • class Enlighten IPrecompInputProbeSet
  • class Enlighten IPrecompInputSystem
  • class Enlighten IPrecompMeshValidation
  • class Enlighten IPrecompOutputCubeMap
  • class Enlighten IPrecompOutputProbeOctree
  • class Enlighten IPrecompOutputProbeSet
  • class Enlighten IPrecompPackedGeometry
  • class Enlighten IPrecompPackedInstance
  • class Enlighten IPrecompPackedSystem
  • class Enlighten IPrecompProbeSetBuildParameters
  • class Enlighten IPrecompProbeSetRadiosity
  • class Enlighten IPrecompRadiosityNormalTexture
  • class Enlighten IPrecompSystemClustering
  • class Enlighten IPrecompSystemCompressedLightTransport
  • class Enlighten IPrecompSystemDependencies
  • class Enlighten IPrecompSystemDuster
  • class Enlighten IPrecompSystemLightTransport
  • class Enlighten IPrecompSystemPreClustering
  • class Enlighten IPrecompSystemRadiosity
  • class Enlighten IPrecompSystemsDependencies
  • class Enlighten IPrecompute
  • class Enlighten IPrecomputeLoaderCubeMap
  • class Enlighten IPrecomputeLoaderGeometry
  • class Enlighten IPrecomputeLoaderProbeSet
  • class Enlighten IPrecomputeLoaderSystem
  • class Enlighten IPrecompVolumeQuery
  • class Enlighten IProbeSetManager
  • class Enlighten IrradianceOutputDesc
  • class Enlighten ISystemSolutionSpace
  • class Enlighten IThreadGroup
  • class Enlighten IUpdateManager
  • class Enlighten IUpdateManagerWorker
  • class Enlighten IViewVolumeIntersector
  • class Enlighten LightMethodSelector
  • class Enlighten LightTransportPixel
  • class Enlighten LightValue64
  • class Enlighten LightValueIterator
  • class Enlighten Line2D
  • class Enlighten LongRunningProcess
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten IPrecompInputProbeOctree

    This is the documentation for Enlighten.

    class Enlighten IPrecompInputProbeOctree

    Nov 21, 2019

    class Enlighten::IPrecompInputProbeOctree

        └>Geo::IGeoSerialisable
            └>Geo::IGeoReleasable

    Represents a region of 3D space within which sets of probe positions are adaptively generated.

    Functions

    Name Description
    Create()

    Create a new empty IPrecompInputProbeOctree.

    Create(const IPrecompInputProbeRegion *const *, Geo::s32)

    Create a new IPrecompInputProbeOctree that represents the specified regions.

    Create(const IPrecompVolumeQuery &, float)

    Create a new IPrecompInputProbeOctree that represents the specified volume with voxels of the specified size.

    Create(float, const PrecompInputOctreeVolume *, Geo::s32, const PrecompInputOctreePointSet *, Geo::s32, const PrecompInputOctreeBoxSet *, Geo::s32)

    Create a new IPrecompInputProbeOctree that represents the specified region of 3D space with voxels of the specified size.

    GetBuildParameters()

    Edit the build parameters for this probe octree.

    GetBuildParameters()

    Read only access to the build parameters for this probe octree.

    GetName()

    Get the full name.

    Load(IGeoInputStream &, Geo::u32)

    Load an instance of this class from an IGeoInputStream.

    Release()

    Free this object that was created within the Enlighten libraries.

    Save(IGeoStream &, Geo::u32)

    Save an instance of this class to an IGeoStream.

    SetName(const char *)

    Set a globally unique name.


    static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create

    public: IPrecompInputProbeOctree * Create()

    Create a new empty IPrecompInputProbeOctree.


    static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create

    public: IPrecompInputProbeOctree * Create
    (
        const IPrecompInputProbeRegion *const * regions,
        Geo::s32 count
    )

    Create a new IPrecompInputProbeOctree that represents the specified regions.

    Parameters
    [in] regions

    The regions which combined represent the desired volume. Note: object lifetime must be at least the duration of this function call.

    [in] count

    The number of entries in the regions array.


    static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create

    public: IPrecompInputProbeOctree * Create
    (
        const IPrecompVolumeQuery & volume,
        float voxelSize
    )

    Create a new IPrecompInputProbeOctree that represents the specified volume with voxels of the specified size.

    Parameters
    [in] volume

    An implementation of IPrecompVolumeQuery which represents the desired volume. Note: object lifetime must be at least the duration of this function call.

    [in] voxelSize

    The size of the smallest possible voxel used to represent the volume.


    static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create

    public: IPrecompInputProbeOctree * Create
    (
        float voxelSize,
        const PrecompInputOctreeVolume * volumes,
        Geo::s32 numVolumes,
        const PrecompInputOctreePointSet * pointSets,
        Geo::s32 numPointSets,
        const PrecompInputOctreeBoxSet * boxSets,
        Geo::s32 numBoxSets
    )

    Create a new IPrecompInputProbeOctree that represents the specified region of 3D space with voxels of the specified size.

    Parameters
    [in] voxelSize

    The size of the smallest possible voxel used to represent the region of 3D space.

    [in] volumes

    An array of IPrecompVolumeQuery references which represent the desired region of 3D space. Note: object lifetime must be at least the duration of this function call.

    [in] numVolumes

    The number of entries in the volumes array.

    [in] pointSets

    An array of point sets which represent the desired region of 3D space.

    [in] numPointSets

    The number of entries in the pointSets array.

    [in] boxSets

    An array of box sets which represent the desired region of 3D space.

    [in] numBoxSets

    The number of entries in the boxSets array.


    virtual IPrecompProbeSetBuildParameters* Enlighten::IPrecompInputProbeOctree::GetBuildParameters

    public: IPrecompProbeSetBuildParameters * GetBuildParameters()

    Edit the build parameters for this probe octree.


    virtual const IPrecompProbeSetBuildParameters* Enlighten::IPrecompInputProbeOctree::GetBuildParameters

    public: const IPrecompProbeSetBuildParameters * GetBuildParameters() const

    Read only access to the build parameters for this probe octree.


    virtual const char* Enlighten::IPrecompInputProbeOctree::GetName

    public: const char * GetName() const

    Get the full name.


    virtual bool Geo::IGeoSerialisable::Load

    public: bool Load
    (
        IGeoInputStream & stream,
        Geo::u32 section
    )

    Load an instance of this class from an IGeoInputStream.

    The stream must be ready to read from. You can load sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will load all sections. It is also safe to call this method on an object multiple times with different section arguments to load multiple parts.


    virtual void Geo::IGeoReleasable::Release

    public: void Release()

    Free this object that was created within the Enlighten libraries.

    Expect this to behave in a similar way to calling 'delete(this)'


    virtual bool Geo::IGeoSerialisable::Save

    public: bool Save
    (
        IGeoStream & stream,
        Geo::u32 section
    ) const

    Save an instance of this class to an IGeoStream.

    The stream must be ready to write to. You can save sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will save all sections that are available.


    virtual void Enlighten::IPrecompInputProbeOctree::SetName

    public: void SetName
    (
        const char * name
    )

    Set a globally unique name.

    , multiple selections available,
    {"serverDuration": 10, "requestCorrelationId": "371be4c84e1f44eea22e3fa3321576fb"}