Dali 3D User Interface Engine
List of all members | Public Member Functions | Private Attributes
Dali::Integration::ResourceRequest Class Reference

Used to request a resource from the native filesystem. More...

#include <resource-request.h>

Collaboration diagram for Dali::Integration::ResourceRequest:
Collaboration graph
[legend]

Public Member Functions

 ResourceRequest (ResourceId newId, const ResourceType &resourceType, const std::string &resourcePath, LoadResourcePriority loadPriority=LoadPriorityNormal)
 Used to request a resource be accessed from the native filesystem. More...
 
 ResourceRequest (ResourceId newId, const ResourceType &resourceType, const std::string &resourcePath, ResourcePointer resourcePtr, LoadResourcePriority savePriority=LoadPriorityNormal)
 Used to request or save a resource from/to the native filesystem. More...
 
 ResourceRequest (const ResourceRequest &request)
 Copy constructor. More...
 
ResourceRequestoperator= (const ResourceRequest &rhs)
 Assignment operator. More...
 
 ~ResourceRequest ()
 Non-virtual destructor; not intended as a base class. More...
 
ResourceId GetId () const
 Retrieve the resource ID. More...
 
ResourceTypeGetType () const
 Retrieve the resource type. More...
 
const std::string & GetPath () const
 Retrieve the resource path. More...
 
ResourcePointer GetResource () const
 Retrieve the resource (for save and decode requests) More...
 
LoadResourcePriority GetPriority () const
 Retrieve the load priority. More...
 

Private Attributes

ResourceId id
 
ResourceTypetype
 
std::string path
 
ResourcePointer resource
 When saving resources or decoding them, the resource data will be passed through in a reference counted object here. More...
 
LoadResourcePriority priority
 

Detailed Description

Used to request a resource from the native filesystem.

Definition at line 55 of file resource-request.h.

Constructor & Destructor Documentation

Dali::Integration::ResourceRequest::ResourceRequest ( ResourceId  newId,
const ResourceType resourceType,
const std::string &  resourcePath,
LoadResourcePriority  loadPriority = LoadPriorityNormal 
)
inline

Used to request a resource be accessed from the native filesystem.

Parameters
[in]newIdA unique ID for this request.
[in]resourceTypeThe type of resource requested. The implementation of PlatformAbstraction::LoadResource() is responsible for converting the native file(s) to this type e.g. decoding a jpeg to a bitmap.
[in]resourcePathThe path of the resource; typically a filename.
[in]loadPriorityThe priority of the request.

Definition at line 69 of file resource-request.h.

References Dali::Integration::ResourceType::Clone(), and type.

Here is the call graph for this function:

Dali::Integration::ResourceRequest::ResourceRequest ( ResourceId  newId,
const ResourceType resourceType,
const std::string &  resourcePath,
ResourcePointer  resourcePtr,
LoadResourcePriority  savePriority = LoadPriorityNormal 
)
inline

Used to request or save a resource from/to the native filesystem.

Parameters
[in]newIdA unique ID for this request.
[in]resourceTypeThe type of resource.
[in]resourcePathThe location of the resource / where the resource should be saved.
[in]resourcePtrThe resource to decode / save.
[in]savePriorityThe priority of the request.

Definition at line 89 of file resource-request.h.

References Dali::Integration::ResourceType::Clone(), and type.

Here is the call graph for this function:

Dali::Integration::ResourceRequest::ResourceRequest ( const ResourceRequest request)
inline

Copy constructor.

Parameters
[in]requestThe resource request to copy.

Definition at line 107 of file resource-request.h.

References Dali::Integration::ResourceType::Clone(), and type.

Here is the call graph for this function:

Dali::Integration::ResourceRequest::~ResourceRequest ( )
inline

Non-virtual destructor; not intended as a base class.

Definition at line 138 of file resource-request.h.

References type.

Member Function Documentation

ResourceId Dali::Integration::ResourceRequest::GetId ( ) const
inline

Retrieve the resource ID.

Returns
The ID

Definition at line 147 of file resource-request.h.

References id.

Referenced by anonymous_namespace{utc-Dali-Internal-ResourceClient.cpp}::CheckLoadBitmap(), Dali::TizenPlatform::ResourceThreadImage::Decode(), Dali::TizenPlatform::ResourceThreadImage::DecodeImageFromMemory(), Dali::TizenPlatform::ResourceThreadImage::DownloadRemoteImageIntoMemory(), anonymous_namespace{utc-Dali-Internal-ImageFactory.cpp}::EmulateImageLoaded(), anonymous_namespace{utc-Dali-ResourceImage.cpp}::LoadBitmapResource(), anonymous_namespace{utc-Dali-Image.cpp}::LoadBitmapResource(), Dali::TizenPlatform::ResourceLoader::ResourceLoaderImpl::LoadFurtherResources(), anonymous_namespace{utc-Dali-Internal-ResourceClient.cpp}::LoadImage(), Dali::TizenPlatform::ResourceThreadImage::LoadImageFromLocalFile(), Dali::TizenPlatform::ResourceLoader::ResourceLoaderImpl::LoadResource(), Dali::TizenPlatform::ResourceLoader::ResourceLoaderImpl::StoreRequest(), anonymous_namespace{utc-Dali-RendererFactory.cpp}::TestControlRendererRender(), UtcDaliImageActorGetCurrentSize02(), UtcDaliImageActorGetCurrentSize03(), UtcDaliImageActorGetCurrentSize04(), UtcDaliImageActorGetCurrentSize05(), UtcDaliImageActorNaturalPixelAreaSize01(), UtcDaliImageActorNaturalPixelAreaSize02(), UtcDaliImageSignalUploaded(), UtcDaliInternalRequestReloadBitmapRequests03(), UtcDaliInternalRequestResourceBitmapRequests02(), UtcDaliInternalRequestResourceBitmapRequests03(), UtcDaliRenderTaskContinous05(), UtcDaliRenderTaskContinuous01(), UtcDaliRenderTaskContinuous02(), UtcDaliRenderTaskContinuous03(), UtcDaliRenderTaskContinuous04(), UtcDaliRenderTaskOnce01(), UtcDaliRenderTaskOnce02(), UtcDaliRenderTaskOnce03(), UtcDaliRenderTaskOnce04(), UtcDaliRenderTaskOnce05(), UtcDaliRenderTaskOnce07(), UtcDaliRenderTaskOnce08(), UtcDaliRenderTaskOnce09(), UtcDaliRenderTaskOnce10(), UtcDaliRenderTaskOnceChain01(), UtcDaliRenderTaskOnceNoSync01(), UtcDaliRenderTaskOnceNoSync02(), UtcDaliRenderTaskOnceNoSync03(), UtcDaliRenderTaskOnceNoSync04(), UtcDaliRenderTaskOnceNoSync05(), UtcDaliRenderTaskOnceNoSync07(), UtcDaliRenderTaskOnceNoSync08(), UtcDaliRenderTaskOnceNoSync09(), UtcDaliRenderTaskOnceNoSync10(), UtcDaliResourceImageGetLoadingState02(), UtcDaliResourceImageSignalLoadingFinished(), and UtcDaliShaderEffectFromPropertiesP().

const std::string& Dali::Integration::ResourceRequest::GetPath ( ) const
inline
LoadResourcePriority Dali::Integration::ResourceRequest::GetPriority ( ) const
inline

Retrieve the load priority.

Returns
The priority

Definition at line 183 of file resource-request.h.

References priority.

ResourcePointer Dali::Integration::ResourceRequest::GetResource ( ) const
inline

Retrieve the resource (for save and decode requests)

Returns
The resource

Definition at line 174 of file resource-request.h.

References resource.

Referenced by Dali::TizenPlatform::ResourceThreadImage::Decode(), and Dali::TizenPlatform::ResourceBitmapRequester::LoadResource().

Here is the caller graph for this function:

ResourceType* Dali::Integration::ResourceRequest::GetType ( ) const
inline

Retrieve the resource type.

Returns
The type

Definition at line 156 of file resource-request.h.

References type.

Referenced by anonymous_namespace{utc-Dali-Internal-ResourceClient.cpp}::CheckLoadBitmap(), Dali::TizenPlatform::ResourceThreadImage::DecodeImageFromMemory(), anonymous_namespace{utc-Dali-Internal-ImageFactory.cpp}::EmulateImageLoaded(), anonymous_namespace{utc-Dali-ResourceImage.cpp}::LoadBitmapResource(), anonymous_namespace{utc-Dali-Image.cpp}::LoadBitmapResource(), Dali::TizenPlatform::ResourceLoader::ResourceLoaderImpl::LoadFurtherResources(), anonymous_namespace{utc-Dali-Internal-ResourceClient.cpp}::LoadImage(), Dali::TizenPlatform::ResourceThreadImage::LoadImageFromLocalFile(), Dali::TizenPlatform::ResourceBitmapRequester::LoadResource(), Dali::TestPlatformAbstraction::LoadResource(), Dali::TizenPlatform::ResourceLoader::ResourceLoaderImpl::LoadResource(), anonymous_namespace{utc-Dali-RendererFactory.cpp}::TestControlRendererRender(), UtcDaliImageActorGetCurrentSize02(), UtcDaliImageActorGetCurrentSize03(), UtcDaliImageActorGetCurrentSize04(), UtcDaliImageActorGetCurrentSize05(), UtcDaliImageActorNaturalPixelAreaSize01(), UtcDaliImageActorNaturalPixelAreaSize02(), UtcDaliImageSignalUploaded(), UtcDaliRenderTaskContinous05(), UtcDaliRenderTaskContinuous01(), UtcDaliRenderTaskContinuous02(), UtcDaliRenderTaskContinuous03(), UtcDaliRenderTaskContinuous04(), UtcDaliRenderTaskOnce01(), UtcDaliRenderTaskOnce02(), UtcDaliRenderTaskOnce03(), UtcDaliRenderTaskOnce04(), UtcDaliRenderTaskOnce05(), UtcDaliRenderTaskOnce07(), UtcDaliRenderTaskOnce08(), UtcDaliRenderTaskOnce09(), UtcDaliRenderTaskOnceChain01(), UtcDaliRenderTaskOnceNoSync01(), UtcDaliRenderTaskOnceNoSync02(), UtcDaliRenderTaskOnceNoSync03(), UtcDaliRenderTaskOnceNoSync04(), UtcDaliRenderTaskOnceNoSync05(), UtcDaliRenderTaskOnceNoSync07(), UtcDaliRenderTaskOnceNoSync08(), UtcDaliRenderTaskOnceNoSync09(), UtcDaliResourceImageSignalLoadingFinished(), and UtcDaliShaderEffectFromPropertiesP().

Here is the caller graph for this function:

ResourceRequest& Dali::Integration::ResourceRequest::operator= ( const ResourceRequest rhs)
inline

Assignment operator.

Parameters
[in]rhsThe resource request to copy.

Definition at line 121 of file resource-request.h.

References Dali::Integration::ResourceType::Clone(), id, path, priority, resource, and type.

Here is the call graph for this function:

Member Data Documentation

ResourceId Dali::Integration::ResourceRequest::id
private

Definition at line 190 of file resource-request.h.

Referenced by GetId(), and operator=().

std::string Dali::Integration::ResourceRequest::path
private

Definition at line 192 of file resource-request.h.

Referenced by GetPath(), and operator=().

LoadResourcePriority Dali::Integration::ResourceRequest::priority
private

Definition at line 196 of file resource-request.h.

Referenced by GetPriority(), and operator=().

ResourcePointer Dali::Integration::ResourceRequest::resource
private

When saving resources or decoding them, the resource data will be passed through in a reference counted object here.

When Loading, it will be null.

Definition at line 195 of file resource-request.h.

Referenced by GetResource(), and operator=().

ResourceType* Dali::Integration::ResourceRequest::type
private

Definition at line 191 of file resource-request.h.

Referenced by GetType(), operator=(), ResourceRequest(), and ~ResourceRequest().


The documentation for this class was generated from the following file:
Dali Docs Home
Read more about Dali