File size: 10,902 Bytes
f56a29b | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 | /**
* Stage API - Canvas Operations
*
* Factory function that creates the canvas namespace of the Stage API.
* Handles background, theme, highlight, spotlight, laser, and zoom effects.
* Uses useCanvasStore for visual overlay effects.
*/
import type { SlideContent } from '@/lib/types/stage';
import type { SlideTheme, SlideBackground } from '@/lib/types/slides';
import { useCanvasStore } from '@/lib/store/canvas';
import type { StageStore, APIResult, HighlightOptions, SpotlightOptions } from './stage-api-types';
import { getScene } from './stage-api-defaults';
/**
* Create the canvas operations API
*
* @param store - Zustand store instance
* @returns Canvas namespace API
*/
export function createCanvasAPI(store: StageStore) {
return {
/**
* Set background
*
* @param sceneId - Scene ID
* @param background - Background settings
* @returns Whether successful
*/
setBackground(sceneId: string, background: SlideBackground): APIResult<boolean> {
try {
const state = store.getState();
const scene = getScene(state.scenes, sceneId);
if (!scene || scene.type !== 'slide') {
return { success: false, error: 'Invalid scene' };
}
const content = scene.content as SlideContent;
const newScenes = state.scenes.map((s) => {
if (s.id === sceneId) {
return {
...s,
content: {
...content,
canvas: {
...content.canvas,
background,
},
},
updatedAt: Date.now(),
};
}
return s;
});
store.setState({ scenes: newScenes });
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Set theme
*
* @param sceneId - Scene ID
* @param theme - Theme settings
* @returns Whether successful
*/
setTheme(sceneId: string, theme: Partial<SlideTheme>): APIResult<boolean> {
try {
const state = store.getState();
const scene = getScene(state.scenes, sceneId);
if (!scene || scene.type !== 'slide') {
return { success: false, error: 'Invalid scene' };
}
const content = scene.content as SlideContent;
const newScenes = state.scenes.map((s) => {
if (s.id === sceneId) {
return {
...s,
content: {
...content,
canvas: {
...content.canvas,
theme: {
...content.canvas.theme,
...theme,
},
},
},
updatedAt: Date.now(),
};
}
return s;
});
store.setState({ scenes: newScenes });
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Highlight an element (teaching feature)
*
* Emphasize an element by adding a highlight border or shadow
*
* @param sceneId - Scene ID
* @param elementId - Element ID
* @param options - Highlight options
* @returns Whether successful
*/
highlight(
sceneId: string,
elementId: string,
options: HighlightOptions = {},
): APIResult<boolean> {
const { duration, color = '#ff6b6b', style = 'outline' } = options;
try {
// Use the new Canvas Store highlight overlay API
// Advantage: does not modify the element itself, purely visual effect
const canvasStore = useCanvasStore.getState();
canvasStore.setHighlight([elementId], {
color,
opacity: style === 'fill' ? 0.3 : 0.5,
borderWidth: 3,
animated: true,
});
// If duration is set, automatically clear the highlight
if (duration) {
setTimeout(() => {
canvasStore.clearHighlight();
}, duration);
}
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Spotlight effect (teaching feature)
*
* Highlight a specific element while dimming everything else
* Note: this requires a mask layer in the frontend rendering layer
*
* @param sceneId - Scene ID
* @param elementId - Element ID
* @param options - Spotlight options
* @returns Whether successful
*/
spotlight(
sceneId: string,
elementId: string,
options: SpotlightOptions = {},
): APIResult<boolean> {
try {
// Use Canvas Store's spotlight API
const canvasStore = useCanvasStore.getState();
canvasStore.setSpotlight(elementId, options);
// If duration is set, automatically clear the spotlight
if (options.duration) {
setTimeout(() => {
canvasStore.clearSpotlight();
}, options.duration);
}
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Clear all highlight and spotlight effects
*
* @param sceneId - Scene ID
* @returns Whether successful
*/
clearHighlights(_sceneId: string): APIResult<boolean> {
try {
// Use Canvas Store to clear all teaching effects
const canvasStore = useCanvasStore.getState();
canvasStore.clearHighlight();
canvasStore.clearSpotlight();
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Clear spotlight effect
*
* @returns Whether successful
*/
clearSpotlight(_sceneId?: string): APIResult<boolean> {
try {
const canvasStore = useCanvasStore.getState();
canvasStore.clearSpotlight();
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Set percentage-mode spotlight
*
* @param sceneId - Scene ID
* @param elementId - Element ID
* @param geometry - Percentage geometry info
* @param options - Spotlight options
* @returns Whether successful
*/
setSpotlightPercentage(
sceneId: string,
elementId: string,
geometry: import('@/lib/types/action').PercentageGeometry,
options: SpotlightOptions = {},
): APIResult<boolean> {
try {
const canvasStore = useCanvasStore.getState();
canvasStore.setSpotlightPercentage(elementId, geometry, options);
if (options.duration) {
setTimeout(() => {
canvasStore.clearSpotlight();
}, options.duration);
}
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Set laser pointer effect
*
* @param sceneId - Scene ID
* @param elementId - Element ID
* @param geometry - Percentage geometry info
* @param options - Laser pointer options
* @returns Whether successful
*/
setLaser(
sceneId: string,
elementId: string,
geometry: import('@/lib/types/action').PercentageGeometry,
options: import('@/lib/store/canvas').LaserOptions = {},
): APIResult<boolean> {
try {
const canvasStore = useCanvasStore.getState();
canvasStore.setLaser(elementId, options);
if (options.duration) {
setTimeout(() => {
canvasStore.clearLaser();
}, options.duration);
}
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Clear laser pointer effect
*
* @param sceneId - Scene ID
* @returns Whether successful
*/
clearLaser(_sceneId: string): APIResult<boolean> {
try {
const canvasStore = useCanvasStore.getState();
canvasStore.clearLaser();
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Set zoom effect
*
* @param sceneId - Scene ID
* @param elementId - Element ID
* @param geometry - Percentage geometry info
* @param scale - Zoom scale
* @returns Whether successful
*/
setZoom(
sceneId: string,
elementId: string,
geometry: import('@/lib/types/action').PercentageGeometry,
scale: number,
): APIResult<boolean> {
try {
const canvasStore = useCanvasStore.getState();
canvasStore.setZoom(elementId, scale);
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Clear zoom effect
*
* @param sceneId - Scene ID
* @returns Whether successful
*/
clearZoom(_sceneId: string): APIResult<boolean> {
try {
const canvasStore = useCanvasStore.getState();
canvasStore.clearZoom();
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Clear all visual effects (spotlight, laser, zoom, etc.)
*
* @param sceneId - Scene ID
* @returns Whether successful
*/
clearAllEffects(_sceneId: string): APIResult<boolean> {
try {
const canvasStore = useCanvasStore.getState();
canvasStore.clearAllEffects();
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Highlight multiple elements in batch
*
* @param sceneId - Scene ID
* @param elementIds - Element ID list
* @param options - Highlight options
* @returns Whether successful
*/
highlightMultiple(
sceneId: string,
elementIds: string[],
options: HighlightOptions = {},
): APIResult<boolean> {
const { duration, color = '#ff6b6b' } = options;
try {
const canvasStore = useCanvasStore.getState();
canvasStore.setHighlight(elementIds, {
color,
opacity: 0.3,
borderWidth: 3,
animated: true,
});
if (duration) {
setTimeout(() => {
canvasStore.clearHighlight();
}, duration);
}
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
};
}
|