ATMHud 技术文档

1. 安装指南

环境要求

• iOS 4.0 或更高版本
• QuartzCore.framework
• AudioToolbox.framework（仅在使用声音效果时需要）

安装步骤

1. 下载 ATMHud 项目源码。
2. 将 ATMHud 文件夹拖入您的 Xcode 项目中。
3. 确保在项目设置中添加了 QuartzCore.framework 和 AudioToolbox.framework。
4. 在需要使用 ATMHud 的文件中导入头文件：

   #import "ATMHud.h"
   

2. 项目使用说明

基本使用

ATMHud 是一个用于在 iPhone 应用程序中创建 HUD（Heads-Up Display）的库。它提供了多种功能，如自动旋转支持、动画、自定义外观等。

示例代码

以下是一个简单的示例，展示如何创建和显示一个 HUD：

ATMHud *hud = [[ATMHud alloc] initWithDelegate:self];
[self.view addSubview:hud.view];

[hud setCaption:@"Loading..."];
[hud setActivity:YES];
[hud show];

功能说明

• 自动旋转支持：ATMHud 支持视图的自动旋转，确保在设备旋转时 HUD 也能正确显示。
• 动画：支持多种动画效果，如淡入淡出、缩放等。
• 自定义外观：可以通过设置属性来自定义 HUD 的外观，如背景颜色、字体、大小等。
• 声音效果：支持添加声音效果，需引入 AudioToolbox.framework。

3. 项目 API 使用文档

ATMHud 类

• initWithDelegate:：初始化 HUD 并设置代理。
• setCaption:：设置 HUD 的标题。
• setActivity:：设置是否显示活动指示器。
• show：显示 HUD。
• hide：隐藏 HUD。

ATMHudDelegate 协议

• hudWillAppear:：HUD 即将显示时的回调。
• hudDidAppear:：HUD 显示完成后的回调。
• hudWillDisappear:：HUD 即将隐藏时的回调。
• hudDidDisappear:：HUD 隐藏完成后的回调。

4. 项目安装方式

源码安装

1. 从 GitHub 下载 ATMHud 项目源码。
2. 将源码文件夹拖入您的 Xcode 项目中。
3. 添加必要的框架依赖。

静态库安装

1. 下载 ATMHud 的静态库文件。
2. 将静态库文件添加到您的项目中。
3. 添加必要的框架依赖。

通过以上步骤，您可以成功安装并使用 ATMHud 库，为您的 iPhone 应用程序添加美观且功能丰富的 HUD。