 |
PanoShard
360 Gigapixel Panorama Framework
|
|
PanoShard
360 Gigapixel Panorama Framework
|
| ▼NReshardic | |
| ▼NPanoShard | |
| ►NAttributes | |
| CClassDescriptionAttribute | Attribute that allows adding a description to a MonoBehaviour class which will be displayed at the top of the inspector |
| CFoldoutAttribute | Attribute to group properties under a foldout in the inspector |
| CTypeSelectorAttribute | Attribute to specify that a Type field should show a dropdown of types derived from a base type |
| ►NControls | |
| CCameraController | Provides functionality for controlling a camera in a 3D environment, including rotation, zoom, and inertia |
| CCameraStrategyFactory | Factory class for creating appropriate camera strategies based on the current environment |
| CDesktopCameraStrategy | Implements the camera strategy for desktop environments using the existing CameraController |
| CDirectionalAttenuation360 | Controls an AudioSource volume based on viewing angle for 360-degree content, simulating directional audio awareness based on camera viewing direction |
| CICameraStrategy | Defines the interface for camera control strategies that can be used with the PanoShard system |
| CPanoShardVRSupport | Helper component to easily connect VR cameras with the PanoShard system |
| CTourManager | Manages the flow and interactions within a virtual tour, including loading locations and hotspots |
| CVRCameraStrategy | Implements the camera strategy for VR environments using XR cameras |
| CVRInteractionHotspotPostprocessor | Automatically adds XR interactability to hotspots as they are spawned in a tour |
| ►NCore | |
| ►NUtils | |
| CJsonSerializer | Provides JSON serialization functionality that can adapt between Unity's JsonUtility and Newtonsoft.Json depending on what's available in the project |
| ►NDebugging | |
| CPanoShardSmokeTest | A smoke test script for validating PanoShard functionality using legacy Unity GUI. Attach this to a GameObject in the scene to enable the debug menu |
| ►NEditor | |
| ►NBuild | |
| CPanoramaFolderInfo | Contains information about panorama folders found in StreamingAssets |
| CPanoShardBuildSceneProcessor | Strips editor-only Dependencies textures from scenes during the build process. The Dependencies folder contains 4K base tile textures used only for editor preview. At runtime, TileLoader streams textures from StreamingAssets, so these are dead weight in the build. This processor modifies scenes in memory only; on-disk scene files remain untouched |
| CPanoShardPostBuildProcessor | Post-build processor that analyzes the built project to identify unused panorama folders and provides an interface for optimizing StreamingAssets content |
| CPanoShardSceneAnalysis | Contains the aggregated results of analyzing multiple scenes for PanoShard content |
| CPanoShardSceneAnalyzer | Analyzes Unity scenes to detect PanoShard components and extract tile folder references |
| CSceneAnalysisResult | Contains the results of analyzing a single scene for PanoShard content |
| CStreamingAssetsAnalysis | Contains the results of analyzing StreamingAssets content in a build |
| CStreamingAssetsOptimizerWindow | Provides a user interface for optimizing StreamingAssets content after a successful build |
| ►NGraph | |
| CCommentNodeView | Represents a visual node for displaying and editing comments in a graph UI |
| CDirectionalEdge | Custom edge that displays directional information based on TourConnectionData.Direction |
| CFloorPlanOpener | |
| CLocationNodeView | Represents a visual node in the tour graph that displays and manages a location's data and associated inspector |
| CTilesFolderPickerWindow | Provides a window for browsing and selecting panorama tile folders from the StreamingAssets directory |
| CTourGraphInspector | A custom inspector for the TourGraph component, providing additional functionality in the Unity Editor for opening the graph by button |
| CTourGraphOpener | Asset open hook so double-click opens the editor window |
| CTourGraphView | Represents a specialized graph view for managing and visualizing a tour graph |
| CTourNodeView | Represents a visual node in a tour graph, providing functionality for creating ports and notifying modifications |
| ►NGuidedTour | |
| CGuidedStepHotspotEditorWindow | Specialized hotspot editor for guided tour steps - inherits hotspot editing functionality but operates on guided step data rather than location data directly |
| CGuidedTourDataOpener | Asset opener for GuidedTourData - opens the guided tour editor when double-clicking |
| CGuidedTourEditorWindow | Elegant editor window for crafting and maintaining linear guided tours |
| CGuidedTourMenuItems | Editor menu items for creating and managing guided tours |
| ►NHotspots | |
| CTextBlockHotspotEditor | Provides an editor for creating and modifying text block hotspots in a tour graph. Used to render the side panel for editing text block hotspots in the PanoShard hotspot editor |
| CTransitionHotspotEditor | Provides an editor for configuring transition hotspots within a tour graph inside of the PanoShard hotspot editor |
| CUrlRedirectHotspotEditor | Editor for URL redirect hotspots |
| CVideoPlayerHotspotEditor | |
| ►NUI | |
| CFloorPlanUIEditor | |
| CMapInteractionControllerEditor | |
| CAudioSourceDirectionalAttenuationExtension | |
| CBrandingUtility | Responsible for loading and providing branding assets for the PanoShard package while taking into account the current Unity Editor theme (dark or light) |
| CClassDescriptionEditor | Custom editor that automatically displays class descriptions for MonoBehaviour components |
| CFloorPlanEditorWindow | |
| CFoldoutAttributeDrawer | |
| CHotspotEditorAttribute | Attribute to mark classes that can render custom hotspot types in the editor |
| CHotspotEditorRegistry | Registry for hotspot editors - discovers and manages custom hotspot editors |
| CHotspotEditorWindow | Panorama hotspot editor - now with: |
| CHotspotInspectorGUI | Utility methods for rendering hotspot data inside editor inspectors |
| CHotspotPanoramaDecoratorAttribute | Attribute used to register panorama decorators for hotspot types |
| CHotspotPanoramaDecoratorEntry | Internal wrapper for decorator metadata |
| CHotspotPanoramaDecoratorRegistry | Discovers and manages panorama decorators that render additional visuals for hotspots |
| CHotspotPanoramaDrawContext | Provides contextual information for rendering a hotspot inside the panorama |
| CIHotspotEditor | Defines the interface for editing and managing hotspot data within a tour graph. You must implement this interface in order to build a custom hotspot editor for a specific hotspot type |
| CIHotspotPanoramaDecorator | Defines a decorator that can render additional visuals for a hotspot inside the panorama view |
| CMacOSPermissionsWindow | Editor window that displays macOS executable permission instructions and allows users to retry setting permissions or manually copy commands to run in Terminal |
| CMetadataResolutionOverride | Runtime-safe resolution override for metadata serialization |
| CNativeTilerWrapper | Provides high-performance native C# panorama tiling for PanoShard, powered by the SkiaSharp library. Handles equirectangular images and outputs multi-level, padded tile sets for use in Unity |
| CNorthMarkerHotspotEditor | Editor for NorthMarkerHotspotData. Allows creating and editing North Marker hotspots in the Hotspot Editor. Enforces a single North Marker per location |
| CPanoShardEditorTheme | Centralised colour palette, texture cache, shared GUIStyles and draw helpers used by all PanoShard editor windows. Keeps visual language consistent across tools and eliminates per-window style duplication |
| CPanoShardHomeWindow | Landing window for the PanoShard asset. Shows asset information, documentation links, and version updates. Can be configured to show on startup |
| CPanoShardPresetEditor | Provides a custom editor for the SplitterPreset class, enabling configuration of preset properties such as tile size, format, quality, and advanced settings specific to KTX output |
| CPanoShardTileMetadata | Represents metadata for PanoShard tile generation, storing information about generation settings |
| CPrepareSceneForPanoshard | |
| CResolutionOverride | Represents an override for resolution settings, including level and resolution values |
| CResolutionOverridePropertyDrawer | Custom property drawer for ResolutionOverride to handle nullable resolution in the inspector |
| CSouthMarkerHotspotEditor | Editor for SouthMarkerHotspotData. Allows creating and editing South Marker hotspots in the Hotspot Editor. Enforces a single South Marker per location |
| CSplitterApplicationDownloader | Handles downloading of splitter applications from the server |
| CSplitterApplicationWindow | Window that manages the UI for downloading splitter applications |
| CSplitterPreset | Defines a preset configuration for generating tiled textures, including settings for tile size, zoom levels, output format, and compression options |
| CTourGraphWindow | Represents a custom editor window for visualizing and editing a TourGraph asset |
| CTourManagerEditor | Custom inspector for TourManager that displays mode-specific fields |
| CTourSceneFromGraphWindow | Provides an editor workflow for generating authoring scenes from a TourGraph definition |
| CTypeSelectorDrawer | Custom property drawer for TypeSelectorAttribute that shows a searchable dropdown of types derived from a base type |
| CUpgradePanoramasWindow | Window for upgrading existing panoramas made with FREE version into non-watermarked version |
| ►NExamples | |
| ►NVR | |
| CSimpleVRRigBridge | Simple example implementation of IVRRigBridge that uses standard Unity Input and raycasting. This is a basic example showing how to create your own VR rig bridge |
| CVRPlatformSetup | Example showing how to register and configure VR interaction for PanoShard. Place this on a GameObject in your scene to automatically set up VR interaction |
| ►NGenerators | |
| CGameObjectTileSystem | GameObject-based tile system implementation. Uses cached Renderer references and a single reusable MaterialPropertyBlock to eliminate per-call allocations |
| CITileSystem | |
| CSphereSegmentGenerator | |
| CTileLoader | Manages the loading, caching, and rendering of spherical panorama tiles for a 360-degree view |
| ►NGraph | |
| CCommentNodeData | Represents the data associated with a comment node, including its unique identifier, position, text, and color |
| CFloorLayer | |
| CFloorPlanData | |
| CFloorPlanMarker | |
| CLocationInfo | Represents metadata and configuration for a specific 360 location |
| CLocationInfoPickerAttribute | Attribute that marks a LocationInfo reference field to use the custom editor picker window |
| CLocationNodeData | Represents data for a location node, including its unique identifier, position, and associated location information |
| CNodeData | Base class for all node data types in the PanoShard graph system |
| CTourConnectionData | Represents the connection data between two locations in a tour, including the origin, destination, and direction of the connection |
| CTourGraph | Represents a graph structure for managing tours, consisting of locations, comments, and connections between them |
| CTourGraphFactory | Factory for creating and configuring TourGraph instances at runtime with a fluent interface |
| ►NGuidedTour | |
| CGuidedLocationData | Represents a guided tour step for a specific location, containing overridden settings, hotspot configuration, and progression rules |
| CGuidedTourData | Main guided tour data container that holds all guided location steps and tour configuration |
| CGuidedTourEvents | Events for guided tour progression and interactions |
| CGuidedTourManager | Manages guided tour experiences, providing controlled navigation and interaction through predefined tour paths with customized settings per step |
| CGuidedTourProgressController | Simplified controller that augments GuidedTourManager with progress tracking, hotspot gating, an optional debug HUD, and step voiceovers |
| CGuidedTourUtils | Shared utility methods for the guided tour system |
| CParallelGuidedTourController | Manages hub-based progression for parallel guided tours, tracking branch completion and gating transitions until all required child steps have been visited |
| ►NHotspots | |
| ►NAnimation | |
| CColorHotspotAnimator | Provides color-based animations for hotspots using SpriteRenderers |
| CHotspotColorAnimState | Represents the state of a color animation for a hotspot, including the target color, the renderer to apply the animation to, and the duration of the animation |
| CIHotspotAnimator | Interface for components that animate hotspots in response to interaction events |
| CUnityAnimatorHotspotAnimator | Controls a Unity Animator component for hotspot animations |
| CHotspotAnchor | Represents an abstract base class for defining interactive hotspots in a tour |
| CHotspotData | Represents the base class for hotspot data, containing common properties and behavior for hotspots in a panoramic environment |
| CNorthMarkerHotspotData | Represents a North Marker hotspot, used to define the north direction in a panorama. This hotspot has no runtime visual representation but is used for orientation alignment |
| CPrefabVersion | Marks a hotspot prefab with a version priority for custom overrides. Higher version values take precedence when multiple prefabs exist for the same type |
| CSceneHotspotBinding | Stores serialized hotspot data for authoring-generated scenes and reinitializes the hotspot at runtime |
| CSouthMarkerHotspotData | Represents a South Marker hotspot, used to define the south direction in a panorama. This is used in conjunction with North Marker to correct non-linear floor plan mappings |
| CTextBlockHotspot | Represents a hotspot that displays a text block when interacted with. Example hotspot |
| CTextBlockHotspotData | Represents hotspot data for a text block, including a title and content |
| CTransitionHotspot | Represents a hotspot that transitions the user to a different location within a tour |
| CTransitionHotspotData | Represents a hotspot that transitions to a different location |
| CUrlRedirectHotspot | Represents a hotspot that opens an external URL when clicked |
| CUrlRedirectHotspotData | Represents the data required to configure a URL redirect hotspot, including the target URL and the image to display as a clickable link |
| CVideoPlayerHotspot | Represents a hotspot that integrates with a VideoPlayer to provide interactive video playback functionality within a tour environment |
| CVideoPlayerHotspotData | Represents the data required to configure a video player hotspot, including playback settings, volume, and attenuation parameters |
| ►NInput | |
| ►NVR | |
| CIVRRigBridge | Interface that allows users to bridge their custom VR rig with the PanoShard hotspot system. Implement this interface to provide interaction data from your VR controllers |
| CVRBridgeInteractionHandler | VR interaction handler that uses a user-provided VR rig bridge. This allows users to connect their custom VR rigs to the PanoShard hotspot system |
| CVRHitInfo | Information about what the VR user is pointing at |
| CDesktopDeviceInfo | Represents a desktop device (PC/Mac/Linux) with mouse and keyboard input |
| CDeviceInfoManager | Manages the current device type and allows registration of custom device types |
| CIDeviceInfo | Interface for custom device type definitions, allowing users to create and register specialized device types beyond Unity's built-in DeviceType enum |
| CIHotspotInteractionHandler | Defines an interface for handling different types of interactions with hotspots |
| CInteractionHandlerRegistry | Central registry for hotspot interaction handlers that allows users to register custom handlers for different device types without modifying core asset code |
| CMobileDeviceInfo | Represents a mobile device (iOS/Android) with touch input |
| CMouseInteractionHandler | Handles mouse-based interactions with hotspots |
| CTouchInteractionHandler | Handles touch-based interactions with hotspots |
| CUIInteractionUtility | Shared helpers for determining whether pointer positions overlap UI elements |
| CUnifiedInput | Provides a unified interface for mouse and pointer input across Legacy and New Input Systems |
| CUnifiedTouch | Represents a touch sample abstracted from either input backend |
| CUnifiedTouchInput | Provides per-frame access to touch samples that work with both the legacy and new input systems |
| CVRControllerInteractionHandler | Interaction handler for VR controller-based interaction with hotspots. Uses controller raycasting and trigger button for selection |
| CVRDeviceInfo | Represents a VR headset device with gaze-based interaction |
| CVRGazeInteractionHandler | Interaction handler for VR gaze-based interaction with hotspots. Uses raycasting from the camera's forward direction and timer-based selection |
| ►NInterop | |
| CPendingRequest | Represents a pending request for a tile, including its identifier and whether it has an associated callback |
| CTileId | Represents a unique identifier for a map tile, defined by its zoom level and X/Y coordinates. All three components are packed into a single 32-bit unsigned integer for minimal memory footprint and fast equality/hashing (single integer comparison) |
| ►NManagers | |
| CPanoshard | Static entry point and controller for the PanoShard Unity asset. Provides centralized access to core functionalities like loading locations, setting URLs, and managing segments. Automatically finds and caches the main TileLoader and SphereSegmentGenerator instances from the scene when first needed |
| ►NPresets | |
| CPanoShardQualityPreset | Stores texture and quality settings for PanoShard panoramas. Settings can be swapped at runtime via the inspector |
| ►NScenes | |
| CLocationSceneDescriptor | Carries metadata about a location authoring scene and assists with runtime binding |
| ►CTourSceneManifest | Maps tour locations to additive scene paths for scene-streaming workflows |
| CEntry | |
| ►NUI | |
| CAutoRotate | Rotate the object in specified axis with specified degrees-per-second speed |
| CFloorPlanAnimationState | Data structure containing the state of a floor plan UI for animation purposes |
| CFloorPlanAnimationUtils | Utility methods for floor plan animations to simplify implementation of IFloorPlanFullscreenAnimator |
| CFloorPlanUI | |
| CIFloorPlanFullscreenAnimator | Interface for floor plan fullscreen animation implementations. Implement this interface to create custom fullscreen transition animations |
| CInstantFloorPlanAnimator | Instant fullscreen transition with no animation. Useful for performance-critical scenarios or when immediate feedback is preferred |
| CIVideoControlsManager | Interface for video control components that manage playback controls |
| CMapInteractionController | Handles interaction with the floor plan map, including zooming and panning. Supports both mouse and touch input using UnifiedInput and UnifiedTouchInput |
| CRadarHandler | Handles the radar display on the floor plan, showing the current camera orientation |
| CSmoothStepFloorPlanAnimator | Default fullscreen animation implementation using smooth step interpolation. Provides a smooth, ease-in-out transition between mini and fullscreen states |
| CTransitionManager | Handles smooth transitions between panoramas with fade effects. This is example implementation and demo usage of OnTransitionStarted and OnTransitionCompleted events |
| CUIVideoRenderer | Manages the fullscreen display of videos from VideoPlayerHotspot components. Implemented as a singleton that can be dynamically instantiated when needed |
| CVideoControlsInteractionHandler | Unified interaction handler for video controls that works across all platforms (Mouse, Touch, VR) Enhanced with mobile touch optimization |
| CVideoControlsManager | Manages video playback controls including scrubbing and time display |
| CVideoControlsPositioner | Positions video controls relative to a video plane, maintaining proper alignment regardless of video aspect ratio changes. Enhanced with fullscreen and mobile orientation support |
| CVideoPlayerControls | |
| CVideoScrubber | Helper component that can be attached to a slider to provide scrubbing functionality Works across all platforms (Mouse, Touch, VR) Enhanced with mobile touch optimization |
| ►NUtils | |
| CFitRenderer | Fit the renderer so the rect transform has the correct width and height and maintain proper anchoring for all child UI elements |
| CISubtitleReader | |
| CSimpleTween | A lightweight utility class for creating simple tweening animations |
| CSrtImporter | Custom importer for SRT subtitle files. This importer reads the content of .srt files and creates a TextAsset in Unity |
| CSrtReader | |
| CSubtitleReaderBase | Base class for time-synchronised subtitle readers |
| CSubtitleSegment | |
| CVttImporter | Custom importer for VTT subtitle files. This importer reads the content of .vtt files and creates a TextAsset in Unity |
| CMathUtility | Utility class for mathematical operations related to panoramic spheres. Provides conversions between different coordinate systems: longitude/latitude, 3D vectors, UV coordinates, and angles |
1.13.2