Pro archviztool

To install and enable the ProArchVizTool features in your project:

• Locate your downloaded plugin folder (e.g., ProArchVizTool).
• Create a folder named Plugins at the root directory of your Unreal Engine project (if it does not already exist).
• Copy and paste the ProArchVizTool folder into your project's Plugins directory.
  

  Figure 1.1: Project root folder structure showing the Plugins directory.
• Open your project in the Unreal Editor.
• Open the Edit menu in the top toolbar of the editor and click on Plugins.
  

  Figure 1.2: Selecting the Plugins menu under Edit.
• Search for Proarchviz tool in the search box.
• Check the checkbox next to the plugin to enable it.
  

  Figure 1.3: Activating the Proarchviz tool version 1.0.
• Restart the editor to complete the activation process.

After activation, the plugin's built-in content, widgets, Blueprints, and assets will be accessible inside the Content Browser under the plugin directory:

• Click on the Settings cog icon in the top-right corner of the Content Browser.
• In the settings dropdown menu, make sure Show C++ Classes and Show Plugin Content are checked.
  

  Figure 1.4: Content Browser settings dropdown with Show Plugin Content checked.
• The plugin directory contains subfolders for Blueprints, UI assets, C++ classes, and configuration files.
  

  Figure 1.5: Viewing the Proarchviz tool content and C++ class folders in the Content Browser.

The GameMode binds the custom pawn, controller, and HUD together to establish the architectural visualization interaction rules:

• Create a new Blueprint Class. In the Pick Parent Class window, search for and select ArchVizGameMode as the parent.
  

  Figure 1.6: Creating a Blueprint class inheriting from the C++ class ArchVizGameMode.
• Save and name this Blueprint (e.g., BP_ArchvizGameMode).
  

  Figure 1.7: The BP_ArchvizGameMode asset in your project Content Browser.
• Open the newly created BP_ArchvizGameMode and navigate to the Details panel:
  • Default Pawn Class: Assign BP_ArchvizPawn.
  • HUD Class: Assign BP_ArchvizHUD.
  • Player Controller Class: Assign BP_ArchvizPlayerController.
  

  Figure 1.8: The BP_ArchvizGameMode components hierarchy view.
  

  Figure 1.9: Assigning the custom Pawn, HUD, and Player Controller overrides.
• Compile and save the Blueprint.

The HUD acts as the user interface controller, managing all tool panels. You can customize the look, branding, language, and sounds of your application here:

• Create a Blueprint Class inheriting from ArchVizHUD (e.g., BP_ArchvizHUD).
  

  Figure 1.10: Creating a Blueprint class inheriting from the C++ class ArchVizHUD.
• Open the HUD Blueprint in the editor.
  

  Figure 1.11: The BP_ArchvizHUD asset in your Content Browser.
• Under the Details panel, configure the Menu Category settings (such as startup menu options, logo texture MenuLogo, quit button visibility, and language selector).
  

  Figure 1.12: Customizing main menu parameters, brand logo, and default tutorial settings.
• Configure the UI Category settings (such as center crosshair size CrosshairDotSize, default opacity, base color, and interactive highlight colors).
  

  Figure 1.13: Setting up crosshair sizing, opacity values, and active selection color codes.
• Configure the Audio Category settings (such as selecting specific sound cue/wav assets for interface interactions like PanelOpenSound, UIClickSound, and LightSwitchSound).
  

  Figure 1.14: Setting up sound effects for panel openings, light toggles, and clicks.
• Compile and save the Blueprint.

Orbit mode allows the user to rotate, pan, and zoom around a target focal point, offering an interactive 3D inspection view of the scene.

• Open your BP_ArchvizPawn Blueprint or select the pawn instance in the level.
• In the Details panel, navigate to the Camera category to configure the custom orbit, panning, and zoom parameters:
  • Orbit Speed & Pan Speed: Define the responsiveness of rotation and horizontal movement.
  • Zoom Speed & Zoom Interp Speed: Set mouse wheel zoom speed and interpolation smoothness.
  • Min Arm Length & Max Arm Length: Establish constraints for minimum and maximum camera zoom distance (e.g., 50.0 to 3000.0).
  • Min Pitch & Max Pitch: Control vertical viewing limits (e.g., -85.0 to 85.0 degrees).
  • Orbit Smooth & Pan Smooth: Configure transition damping parameters for fluid movement.
  • Min FOV & Max FOV: Restrict the Field of View limits (e.g., 30.0 to 110.0 degrees).
  

  Figure 2.1: Configuring the camera parameters on the Archviz Pawn for 3D navigation.
• Under the Collision category, define the pawn's navigation boundaries:
  • Collision Radius: Set the bounding sphere radius to prevent clipping through meshes (e.g., 25.0).
  • Min Height Above Floor: Enforce a minimum safety height for the pawn (e.g., 40.0).
• Select the child Camera component to verify default Unreal Engine parameters under the Camera section:
  • Projection Mode: Set to Perspective.
  • Field of View: Set the default angle (e.g., 90.0 degrees).
  

  Figure 2.2: Adjusting default perspective projection mode and Field of View settings.
• Compile and save the Blueprint.

Floor Plan mode shifts the perspective to a top-down layout map view, letting users inspect floor layout spaces.

• Open the BP_ArchvizPawn Blueprint and navigate to the Details panel.
• Under the Top-Down category, customize the top-down camera behavior:
  • Top Down Height: Set the default camera elevation height above the floor (e.g., 2000.0).
  • Top Down Max Pan X / Y: Restrict horizontal panning bounds in the world space (e.g., 1200.0).
  • Top Down Pan / Rotation / Zoom Smooth: Tune interpolation speeds for panning, rotating, and zooming movements in plan view.
  • Top Down Min Zoom / Max Zoom: Define camera height limits during zoom interactions (e.g., 700.0 to 2000.0).
  • Top Down Pitch: Enforce a default downward pitch angle for top-down perspective alignment (e.g., -60.0).
  • Top Down Min / Max Pitch: Set the allowed pitch range (e.g., -89.9 to -45.0 degrees).
  • Top Down Center Actor: Select or link a center pivot actor to define the main focus center point.
  • Hide in Plan View Tag: Specify an actor tag (e.g., HideInPlan) to automatically hide selected actors (like ceilings or lights) when switching to Floor Plan mode.
  

  Figure 2.3: Adjusting camera projection properties for Floor Plan navigation.
• Add the actor tag HideInPlan to any level meshes that block the top-down camera view (such as ceilings, roof plates, or upper floor boards) to make them disappear automatically in plan view.
• Compile and save the Blueprint.

To setup camera checkpoints in your visualization project:

• Drag and place the CameraViewpoint actor from the content list into your level viewport.
• Position and rotate the actor to face the specific room or area you want to showcase (e.g., the living room, kitchen, or balcony).

Customize the camera properties on the placed actor instance to configure the UI card and transition target:

• Select the placed CameraViewpoint actor in the editor.
  

  Figure 3.1: Details panel configuration for a custom CameraViewpoint actor.
• In the Details panel under the Viewpoint category, configure:
  • Display Name: Enter the text label shown on the HUD selection card (e.g., Living Room).
  • Camera Distance: Adjust the float value for the spring arm length from the pivot point (e.g., 42.0).
  • Camera Rotation: Configure pitch, yaw, and roll default offset values for camera alignment.

To sync environmental lighting with the controller, you must bind your level lighting actors:

• Place the LightingController actor in your level.
• In the Details panel under the Lighting category, link the following actors:
  • Sun Light: Assign your DirectionalLight (representing the sun).
  • Ambient Sky Light: Assign your SkyLight.
  

  Figure 4.1: Linking primary sky lights and entering identification tags.
• Configure the identification tags to locate interior and exterior lights in your scene:
  • Interior Light Tag: Enter InteriorLight (matching tags on your indoor lights).
  • Daylight Light Tag: Enter DaylightPortal (matching tags on your daylight portal lights).

Atmospheric presets are stored in the Scene Presets array, defining sun angles and light settings for each time-of-day option:

• Expand the Presets -> Scene Presets array in the LightingController properties.
• For each preset index (e.g. night, Day), configure the following values:
  • Name: The display name shown in the HUD (e.g., "night", "Day").
  • Icon: Unicode symbol representing the time of day.
  • Time Of Day: Float value between 0.0 and 1.0 controlling the sun's height/rotation (e.g., 0.75 for night, 0.0 for day).
  • Interior Lights On: Check this box if you want interior spot/point lights to turn on automatically during this preset (e.g., night-time).
  • Button Color: The button highlight color used in the HUD menu card.
  

  Figure 4.2: Expanding and customizing the parameters for day and night presets.

To define a collection of lamps under a single UI group:

• Place a LampGroupActor in your level.
• Under the Lamp Group category in the Details panel:
  • Group Name: Set the category header name (e.g., spot).
  • Sub Groups: Add element indices representing subgroups (e.g., Living Room Spots, Kitchen Spots).
  

  Figure 5.1: Defining the primary Group Name and Sub Groups array size.

Link the individual light actors that belong to each subgroup:

• Expand a subgroup index (e.g., Index [1]).
• Set the Name parameter of the subgroup (e.g., spot Salon).
  

  Figure 5.2: Linking the Spot lights array and setting up emissive meshes.
• Add elements to the Lights array and link them to the specific light components or actors (e.g. RectLights, SpotLights) in the level.

To make light fixture meshes glow automatically when turned on:

• Under the subgroup settings:
  • Emissive Mesh Actors: Reference the target static mesh actor in the level.
  • Emissive Material Slots: Enter the material slot index on the static mesh that contains the emissive material (e.g., slot 1).
  • Emissive Parameter Name: Set the scalar parameter name defined in the material shader (e.g., EmissiveIntensity).
  • Emissive Color Parameter Name: Set the vector parameter name for color (e.g., EmissiveColor).
  • Max Emissive Value / Off Emissive Value: Set the intensity multiplier for the emissive glow in the ON (e.g. 0.5) and OFF (e.g. 0.02) states.
  • Max Light Intensity / Default Intensity: Set the light components brightness range.
  • Use Color Temperature / Color Temperature: Enable color temperature presets (e.g. 7500K).
  • Start On / Is On: Toggle checkboxes to define the default active state of the subgroup.
  

  Figure 5.3: Customizing emissive parameters, light intensities, and default states.

Attach and define the mesh slots targets on your interactive actors:

• Attach the MaterialSwapComponent to your target actor (e.g., Aria_Armchair_001).
• Navigate to the Material Swap category in the Details panel:
  • Material Groups: Add elements to define material swapping categories.
  • Group Name: Set the category label (e.g., armchair).
  • Target Slot Indices: Add the slot IDs of the static mesh material slots to modify (e.g., index 2 for seat cushion material).
  

  Figure 6.1: Setting up Material Groups and target slot indexes.

Store the available material choices for users to select in the HUD menu:

• In the target group, expand the Presets array.
  

  Figure 6.2: Assigning material presets, colors, and thumbnails.
• For each preset index, define:
  • Preset Name: Display text shown in the HUD selection card (e.g., Material).
  • Material: Assign the material asset interface.
  • Preview Color: Highlight color shown in the selection card.
  • Preview Thumbnail: The texture asset showing the material texture preview.

Set up the alternative meshes and preview data:

• Attach the FurnitureSwapComponent to your target actor (e.g., wallpanel1).
  

  Figure 7.1: Aligning mesh options, name tags, and grow animations.
• In the Details panel under the Furniture Options category:
  • Furniture Options: Add elements and link alternative static mesh assets (e.g., wallpanel1, wallpanel2, wallpanel3).
  • Furniture Names: Set the name label shown on the HUD cards (e.g., wall pannel 1, wall pannel 2).
  • Furniture Thumbnails: Assign preview thumbnail textures for selection buttons.
  • Grow Duration: Set the animation duration (e.g., 0.25 seconds) for the scaling effect when switching furniture.

Configure material swaps to trigger automatically when specific meshes are activated:

• In the component settings, navigate to the Materials category.
  

  Figure 7.2: Defining slot index mapping under variant material groups.
• In the Per Variant Materials array:
  • Add index elements corresponding to each furniture option (e.g., Index [0] maps to the first wall panel mesh).
  • Material Groups: Add a swapping category under this variant (e.g., Material).
  • Target Slot Indices: Define slot indexes for variant materials (e.g., slot 0).

Set up the specific materials available for each mesh variant:

• Under the variant's material group, expand the Presets array.
  

  Figure 7.3: Assigning material assets and previews for specific furniture variants.
• For each material option, assign:
  • Preset Name: Text label (e.g., Material).
  • Material: The target material interface asset (e.g., floor2 or floor1).
  • Preview Color: Selection card background tint.
  • Preview Thumbnail: The thumbnail texture showing the material sample.

Link child light components to their corresponding furniture mesh option:

• Attach light components (e.g., point lights or spot lights like led_left_var0) as child components to your interactive actor (e.g., wallpanel1).
  

  Figure 8.1: Assigning Var0 tag to associate subcomponent lights with variant meshes.
• Select the target light component, and search for the Tags section in the Details panel.
• In the Component Tags array:
  • Add a unique tag corresponding to the variant index (e.g., enter Var0 at Index [0] to associate this light with the first furniture option).
  • The plugin automatically toggles visibility and settings based on these tags when switching options.

Enable lighting controls on your furniture swapping actor:

• Select your FurnitureSwapComponent.
• Locate the Light category in the Details panel:
  • Has Lights: Check this box to enable integrated light variants.
  • Is Light On: Set the default active state of the variant lights (ON/OFF).
  • Current LEDColor: The active color state of the lights.
  • Current LEDIntensity / Max LEDIntensity: Configure brightness parameters and maximum threshold limit (e.g., 0.3).
  

  Figure 8.2: Configuring Has Lights checkbox and light intensity thresholds.

Configure the preset colors that users can cycle through using sliders/buttons:

• In the FurnitureSwapComponent, expand the Per Variant Materials settings.
• Open the LEDColor Presets array:
  • Add color choices shown in the UI.
  • For each preset, set Name (e.g. yellow, white, blue) and select the corresponding Color parameters.
  

  Figure 8.3: Customizing the names and values for LED color presets.

Configure the screen mesh and texture parameters:

• Attach the TV and Interactable components to your TV actor.
• Create a Material containing a 2D Texture parameter linked to the Emissive channel (e.g., M_TV_Screen).
• Under the TV settings in the Details panel:
  • Static Mesh Component: Assign the static mesh component that represents the screen geometry.
  • Screen Material Slot: Enter the material slot index on the static mesh representing the screen (e.g., slot 1).
  • Param Name: Set the texture parameter name defined in the screen shader (e.g., ScreenTexture).

Configure the spatialized audio that matches the video states:

• Add an child Audio component to your TV actor (e.g., TV_Sound).
  

  Figure 9.1: Configuring the screen mesh, material parameters, and child audio component.
• Under the TV component settings, assign the child component:
  • Audio Component: Link the child audio component.
  • Sound Attenuation: Link a Sound Attenuation asset (e.g., ATT_TV) to physicalize distance-based audio volume falloff.

Configure media players and default texture states:

• Locate the TV category settings:
  • Media Player: Link your custom Unreal Engine MediaPlayer asset.
  • Video Source: Assign a default Media Source asset (local MP4 file or network stream).
  • Default Screen Color: Configure the background color of the screen when turned OFF.
  • Intensity Screen: Adjust the emissive texture glow brightness when turned ON (e.g., 1.5).
  

  Figure 9.2: Binding MediaPlayer objects, setting default video streams, and tuning screen brightness.

Configure the movement type, target mesh, and limits:

• Attach the Door and Interactable components to your door actor.
• Under the Door category in the Details panel, configure the mechanical parameters:
  • Door Type: Select Rotation (for swing doors) or Sliding (for drawers, cabinets, and sliding doors).
  • Target Component: Select the child static mesh component to animate (e.g., the door panel mesh).
  • Limits:
  • Max Rotation Angle: Define the maximum swing angle in degrees (e.g., 90.0 or -90.0).
  • Max Slide Distance: Define the maximum sliding distance in centimeters (e.g., 120.0).
  • Door Speed: Adjust the open/close animation speed multiplier (e.g., 3.0).

Sync double doors and configure spatialized sound assets:

• Link double doors to open together:
  • Linked Doors: Add actors to the array to trigger synchronous openings (e.g., when the left door is clicked, the right door swings open automatically).
• Configure audio effects under the Audio category:
  • Open Sound & Close Sound: Assign sound cue assets for opening and closing sounds.
  • Audio Attenuation: Link a Sound Attenuation asset to enforce distance-based audio falloff.
  

  Figure 10.1: Configuring movement types, animation limits, dual-door linkages, and spatialized audio cues.

Set up the mechanical handle rotation when the faucet is turned on:

• Select the Faucet Actor in your level (e.g., faucet_cgsan_com001).
• Attach the Faucet and Interactable components.
• Select the Faucet component and navigate to the Faucet category in the Details panel:
  • Handle Component Name: Enter the exact name of the child static mesh component representing the handle (leave as None to target the default handle sub-component).
  • Open Rotation Offset: Set the rotation values (Roll, Pitch, Yaw) applied to the handle when fully opened (e.g., -90.0, 0.0, 0.0 degrees).
  • Animation Speed: Adjust the speed multiplier for the rotation animation (e.g., 2.5).

Configure the visual water flow using Alembic Geometry Cache files or Niagara particle systems:

• Attach a Geometry Cache component as a child component to the actor.
• Select the Geometry Cache component and assign the source asset (e.g., water_simulation) and the water material (e.g., M_Water_Ocean1).
  

  Figure 11.1: Geometry Cache component structure and water material slot configuration.
• Under the Faucet component properties, configure the following:
  • Water Effect: Link a particle system or Niagara effect if not using Geometry Cache (otherwise set to None).
  • Water Attach Point Name: The name of the socket or attach point on the mesh where the water simulation should align (e.g., None).
  • Alembic Category:
  • Loop Start Time: Set the start timestamp in seconds for the looped section of the Alembic simulation cache (e.g., 1.0).
  • Loop End Time: Set the end timestamp in seconds for the looped section (e.g., 3.9).
  • Auto Align Water: Check to let the system automatically position the water stream.
  • Water ZScale: Define the vertical scaling scale factor for the water flow (e.g., 1.0).

Configure the spatialized audio that matches the running water states:

• Locate the Audio category under the Faucet component:
  • Water Sound: Assign the sound wave or cue asset for flowing water (e.g., Bathroom_Tap_Water_Source).
  • Loop Sound: Check this box to enable continuous looping of the flowing sound while the tap is active.
  • Audio Attenuation: Link a Sound Attenuation asset (e.g., ATT_water) to enable physical distance-based audio volume falloff.
  

  Figure 11.2: Faucet movement properties, audio settings, and Alembic cache looping parameters.

Create and fill the central catalog database with product details:

• Open your ProductCatalog Data Table asset in the Unreal Editor.
• Click Add to create a new row, and assign a unique Row Name identifier (e.g., Canape_Loft_4P).
• Fill out the properties in the Row Editor:
  • Product Name: The display title shown to users (e.g., Canapé Loft 4 Places).
  • Brand Name: Manufacturer/Brand label (e.g., Maison Design DZ).
  • Price / Currency: Numeric cost and currency symbol (e.g., 3500.0 and $).
  • Description: A detailed description of dimensions, materials, and styling (e.g., scandinavian design, fabric details).
  • Product URL: A direct external hyperlink to the product's official purchase page.
  • Category: Group tag (e.g., Sofa).
  • Thumbnail: Select a 2D preview texture displayed in the catalog HUD panel.
  

  Figure 12.1: Editing catalog database entries, pricing, URLs, and descriptions within the Data Table.

Link interactive scene assets to specific database rows:

• Select your target actor in the viewport (e.g., canape).
• In the components list, add the ProductInfo component (ensure the actor also contains the Interactable component).
• Select the ProductInfo component and go to the Details panel:
  • Product Data Table: Bind the ProductCatalog asset containing the specifications.
  • Product Row Name: Choose or type the default active Row Name (e.g., Canape_Loft_4P).

Sync specifications when a user switches furniture meshes:

• If the actor uses a FurnitureSwapComponent, expand the Catalog category under the ProductInfo settings.
• In the Per Variant Row Names array, add rows corresponding directly to the mesh options in the swap component.
• Assign each element index to its corresponding row name (e.g., Index [0] = Canape_Loft_4P, Index [1] = Canape_Narozna_3P, Index [2] = Canape_Lavsit_3P, etc.).
• When a user cycles through options in the viewport, the HUD catalog panel dynamically updates to show the selected variant's active specs, brand, pricing, and purchase link.
  

  Figure 12.2: Details panel configuration linking the ProductInfo component to the catalog table and variant rows.

Configure the basic labeling and 3D positioning for your room annotations:

• Select your annotation actor in the level (e.g., salon_2).
• Attach the room_annotation component.
• Select the room_annotation component and locate the Annotation and Display categories in the Details panel:
  • Room Name: Enter the text label shown in the 3D badge (e.g., salon).
  • Badge Color: Click the color picker to set the theme color of the 3D floating tag.
  • Annotation Offset: Define the X, Y, and Z coordinate offset values to position the text badge above the actor's pivot point (e.g., 0.0, 0.0, 120.0).

Configure raycasting options to automatically calculate room measurements:

• In the Details panel under the Auto-Detection category:
  • Auto Detect: Check this box to enable automatic raycast measuring.
  • Max Raycast Distance: Define the maximum reach threshold for distance-measuring raycasts (e.g., 2000.0 units).
  • Raycast Height Offset: Offset the height from the actor pivot where raycasts are fired (e.g., 100.0 units).
• Under the Display category, check the specifications to calculate and display:
  • Show Height: Toggle to compute and display the floor-to-ceiling height in meters.
  • Show Surface: Toggle to calculate the surface area in square meters ($m^2$).
  • Show Volume: Toggle to calculate the volume in cubic meters ($m^3$).

Customize the physical layout and visual measurement guidelines:

• Under the Display and Layout settings, configure dimension lines:
  • Show Dimension Lines: Check to render interactive measurement guidelines outlining room edges.
  • Dimension Line Offset: Adjust the spacing/offset of the dimension lines from the wall surfaces (e.g., 30.0).
  • Highlight Thickness Multiplier: Set the line thickness for measurement guidelines (e.g., 2.0).
• Manage bounding boxes and visibility:
  • Hide Mesh in Game: Check this box to hide the reference bounding static mesh or collision volume during play, showing only the text badge and dimension lines.
  • Use Mesh Bounds for Dimensions: When checked, the component uses the static mesh's direct bounding box size to compute dimensions instead of utilizing active raycasting.
  

  Figure 13.1: Details panel configuration for room labeling, auto-detection, display parameters, and mesh visibility.