mirror of
https://github.com/ppy/osu.git
synced 2026-05-18 21:10:46 +08:00
Dean Herbert
0aff50fbf5
This aims to bring some conformity to naming to make it easier to understand component structure for new components. Renames are pulled out of the song select v2 changes and are more relevant there due to many new classes being added. - `V2` suffix is dropped, with v2 components being moved to a relevant V2 namespace. - Related classes have a prefix of the area they are used. - Experimenting with using partial/nested classes in the song select v2 implementation. Not committing to this yet but want to see how it plays out. - Moved base carousel components to a generic namespace to avoid confusion with actual beatmap carousel implementation.
60 lines
1.9 KiB
C#
60 lines
1.9 KiB
C#
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
|
// See the LICENCE file in the repository root for full licence text.
|
|
|
|
using System;
|
|
|
|
namespace osu.Game.Graphics.Carousel
|
|
{
|
|
/// <summary>
|
|
/// Represents a single display item for display in a <see cref="Carousel{T}"/>.
|
|
/// This is used to house information related to the attached model that helps with display and tracking.
|
|
/// </summary>
|
|
public sealed class CarouselItem : IComparable<CarouselItem>
|
|
{
|
|
public const float DEFAULT_HEIGHT = 50;
|
|
|
|
/// <summary>
|
|
/// The model this item is representing.
|
|
/// </summary>
|
|
public readonly object Model;
|
|
|
|
/// <summary>
|
|
/// The current Y position in the carousel.
|
|
/// This is managed by <see cref="Carousel{T}"/> and should not be set manually.
|
|
/// </summary>
|
|
public double CarouselYPosition { get; set; }
|
|
|
|
/// <summary>
|
|
/// The height this item will take when displayed. Defaults to <see cref="DEFAULT_HEIGHT"/>.
|
|
/// </summary>
|
|
public float DrawHeight { get; set; } = DEFAULT_HEIGHT;
|
|
|
|
/// <summary>
|
|
/// Defines the display depth relative to other <see cref="CarouselItem"/>s.
|
|
/// </summary>
|
|
public int DepthLayer { get; set; }
|
|
|
|
/// <summary>
|
|
/// Whether this item is visible or hidden.
|
|
/// </summary>
|
|
public bool IsVisible { get; set; } = true;
|
|
|
|
/// <summary>
|
|
/// Whether this item is expanded or not. Should only be used for headers of groups.
|
|
/// </summary>
|
|
public bool IsExpanded { get; set; }
|
|
|
|
public CarouselItem(object model)
|
|
{
|
|
Model = model;
|
|
}
|
|
|
|
public int CompareTo(CarouselItem? other)
|
|
{
|
|
if (other == null) return 1;
|
|
|
|
return CarouselYPosition.CompareTo(other.CarouselYPosition);
|
|
}
|
|
}
|
|
}
|