Enum Class TextureAtlasLayoutService.Unavailable
java.lang.Object
java.lang.Enum<TextureAtlasLayoutService.Unavailable>
dev.turboism.sdk.cubism.textureatlas.TextureAtlasLayoutService.Unavailable
- All Implemented Interfaces:
TextureAtlasLayoutService,Serializable,Comparable<TextureAtlasLayoutService.Unavailable>,Constable
- Enclosing interface:
- TextureAtlasLayoutService
public static enum TextureAtlasLayoutService.Unavailable
extends Enum<TextureAtlasLayoutService.Unavailable>
implements TextureAtlasLayoutService
Sentinel returned by
TextureAtlasLayoutService.unavailable(): reads report empty and applies fail with
TextureAtlasLayoutFailureCode.CAPABILITY_UNAVAILABLE.-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>Nested classes/interfaces inherited from interface dev.turboism.sdk.cubism.textureatlas.TextureAtlasLayoutService
TextureAtlasLayoutService.Unavailable -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionapply(TextureAtlasLayoutTarget target, TextureAtlasLayoutPlan plan) Appliesplantotargetthrough the native atlas-editing path.current()Captures the active layout.booleanReports whether a live runtime backend backs this service.Returns the enum constant of this class with the specified name.values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
INSTANCE
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
isAvailable
public boolean isAvailable()Description copied from interface:TextureAtlasLayoutServiceReports whether a live runtime backend backs this service.- Specified by:
isAvailablein interfaceTextureAtlasLayoutService- Returns:
falsewhen the backend backing this instance is unavailable, including theTextureAtlasLayoutService.unavailable()sentinel
-
current
Description copied from interface:TextureAtlasLayoutServiceCaptures the active layout. On 5.3.02, an existing atlas in the active model is also available before the native atlas editor has first opened or after switching away from the document captured by that editor. This does not create an atlas or open a window. A captured background document is never substituted for the active document.- Specified by:
currentin interfaceTextureAtlasLayoutService
-
apply
public TextureAtlasLayoutApplyResult apply(TextureAtlasLayoutTarget target, TextureAtlasLayoutPlan plan) Description copied from interface:TextureAtlasLayoutServiceAppliesplantotargetthrough the native atlas-editing path.- Specified by:
applyin interfaceTextureAtlasLayoutService- Parameters:
target- the atlas scope the plan applies toplan- a complete layout plan; outside a packing invocation every image must be placed, inside one only the issued images may be placed
-