Package dev.turboism.sdk.cubism.service.read

Interface CubismReadCapabilityService

public interface CubismReadCapabilityService
Read-only Cubism and Editor capability service for SDK-only plugins.

Every result is an SDK-owned immutable DTO. A call can return empty data when no admitted object exists and may fail when a provider is unavailable, host version unsupported, permission denied, or lifecycle admission rejected; no result transfers host-resource ownership.

  • Method Details

    • activeProject

      Optional<ProjectSnapshot> activeProject()
      Returns the active project when it is readable.
      Returns:
      the project snapshot, or empty when absent or unavailable

    • activeDocument

      Optional<DocumentSnapshot> activeDocument()
      Returns the active document when it is readable.
      Returns:
      the document snapshot, or empty when absent or unavailable

    • activeModel

      Optional<ModelSnapshot> activeModel()
      Returns the active model when it is readable.
      Returns:
      the model snapshot, or empty when absent or unavailable

    • selection

      SelectionSnapshot selection()
      Returns the current immutable selection snapshot.
      Returns:
      the current selection, which can be empty

    • parameters

      List<ParameterSnapshot> parameters()
      Lists readable parameter snapshots.
      Returns:
      an immutable parameter list

    • modelObjects

      List<ModelObjectSnapshot> modelObjects()
      Lists readable model-object snapshots.
      Returns:
      an immutable model-object list

    • meshes

      List<ArtMeshSnapshot> meshes()
      Lists readable ArtMesh snapshots.
      Returns:
      an immutable ArtMesh list

    • deformers

      List<DeformerSnapshot> deformers()
      Lists readable deformer snapshots.
      Returns:
      an immutable deformer list

    • psdDocuments

      List<PsdDocumentSnapshot> psdDocuments()
      Lists readable PSD document snapshots.
      Returns:
      an immutable PSD document list

    • clipMasks

      List<ClipMaskSnapshot> clipMasks()
      Lists readable clipping configurations.
      Returns:
      an immutable clip-mask list

    • textureAtlases

      List<TextureAtlasSnapshot> textureAtlases()
      Lists readable texture atlas snapshots.
      Returns:
      an immutable texture-atlas list

    • renderStatus

      Optional<RenderStatusSnapshot> renderStatus()
      Returns the rendering status when the provider exposes it.
      Returns:
      the rendering status, or empty when unavailable

    • workspace

      Optional<WorkspaceSnapshot> workspace()
      Returns the workspace when the provider exposes it.
      Returns:
      the workspace snapshot, or empty when unavailable

    • themeStatus

      Optional<ThemeStatusSnapshot> themeStatus()
      Returns the theme status when the provider exposes it.
      Returns:
      the theme status, or empty when unavailable