OMS Player Content in Windows Explorer
In Unreal, Navigate inside the Movies folder, click Import, and add your MP4 files from your file directory location. Similarly, navigate to the main Content folder, click Import, and add your OMS file from your file directory.The operations for setting up an OMS Player in Unreal is split amongst numerous actors, blueprints, and objects, so you will want to keep these contained. We recommend creating a new folder for each OMS Player in your project. There are several components required to set up OMS Playback in UE4. ```eval_rst .. image:: assets/unreal-contentbrowser1.PNG :width: 1200 ``` ```eval_rst .. image:: assets/unreal-contentbrowser2.PNG :width: 1200 ```OMS Player Content in the Content Browser
- **An OMSMeshActor BluePrint**: This Blueprint drives the core of the OMS playback. It reads your prepared Materials and Media Player, and serves as the OMS player in your project’s map. - **An OMS Mesh Material**: You will need to create a material that uses the ‘ArcturusOMS’ node for the material’s texture information and World Position Offset. This is used as the Mesh Material parameter in the OMSMeshActor Blueprint. - **An OMS Texture Material**: You will need to create a material that uses the ‘Texture Sample’ node to playback the information provided by the Media Player Asset in order to apply the textures to your OMS’s meshes. - **An Media Player Asset**: This asset takes the provided MP4 textures and allows for playback of the texture and mesh animation. - **An Media Texture Asset**: This asset provides the Media Player with the mp4 required to provide texture and OMS playback. To set up an OMS player, create the following: ```eval_rst .. image:: assets/unrealrequiredelements.PNG :width: 1200 ``` 1. **A Media Player**: - Double click on the object and ensure that 'Play on Open' and 'Loop' are enabled. 2. **A Media Texture**: - Double click on the object and set the Media Player to the new MediaPlayer object that you just created. 3. **Two new Materials**: - One of these is a mesh material, and the other is a media texture. For the purpose of this doc, we’ll assume you’ve named these OMSMeshMaterial and OMSMediaTexture. The OMSMeshMaterial must be edited in the Material Editor. Add the ArcturusOMS node. From the new ArcturusOMS node: ```eval_rst .. image:: assets/omsmeshmaterialnode.PNG :width: 1200 ``` 1. Connect the world position offset to the material node’s World Position Offset input 2. Connect the Normals output into the material’s normal input. 3. Next, determine whether your project will have a lit or unlit map. - If you plan on having real time lighting, connect the Texture output to the material node's Base Color and set the shading model to Default Lit. - If unlit, connect the Texture output to the material node's Emissive Color and set the Shading Model to Unlit. The OMSTextureMaterial must be edited in the Material Editor. Add a Texture Sample node. From the Texture Sample node: ```eval_rst .. image:: assets/omstexturematerialnode.PNG :width: 1200 ``` 1. Connect the RGBA output into the Emissive input of the OMSTextureMaterial 2. In the Texture Sample details, this node’s Texture should be set to The OMSMediaTexture you just configured. To drive playback, create a Blueprint using the OMSMeshActor class from “all classes”. This is what you will configure to drive your OMS playback. It takes the assorted components required for texture and mesh playback and lets you determine the volumetric clip you intend to play. ```eval_rst .. image:: assets/mediaplayersetupinblueprint.PNG :width: 2000 ``` Three Nodes are necessary for standard OMS playback: 1. **A Media Player Variable**: Setup of the Media Player Variable requires you to: - Create a new variable in the Variables tab of the My BluePrint panel - Change the new variable’s Variable Type to Media Player - Update the Media Player Media Player parameter (in the Default tab) to the MediaPlayer object you created. - Drag the Media Player Variable into the graph from the Blueprint Panel as a Get. 2. **An Open Source Node**: Click on the output of the Media Player node and drag to an empty spot in the Event Graph. Search for ‘Open Source’ and create the node. In the newly created Open Source node, open the Media Source dropdown menu and select the MP4 file companion of the OMS you will be playing. 3. **An Event Node**: The Event BeginPlay node initiates the playback of your OMS on entering play mode or launching an application. The exec pin of the Event BeginPlay node should be connected to the plug into the exec pin of the Open Source node. Select the OMSMeshActor component and update the Default and OMSSettings parameters in the component’s Details panel as follows: ```eval_rst .. image:: assets/UnrealOMSBlueprintsetup.PNG :width: 2000 ``` **Default:** - Media Player: Select the Media Player Object created for OMS playback **OMSSettings:** - OMS: Select the OMS clip you intend for playback - Media Player Material: Select the OMSTextureMaterial you created for your clip to generate the textures for OMS Playback. - Mesh Material: Select the OMSMeshMaterial you created to generate the mesh for your OMS Playback. **OMS Player in the level editor:** ```eval_rst .. image:: assets/unrealblueprintinleveleditor.PNG :width: 2000 ``` Drag the OMSMeshActor BluePrint from the Content Browser into Unreal’s Level Editor Viewport. Once in the Viewport, the mesh of the first frame of your OMS Clip will be visible without textures. To preview the OMS playback select ‘Play’ from the Viewport toolbar. Note: the Blueprint can be transformed as necessary using Translate, Rotate and Scale. ## Adding Head Retargeting To add head retargeting data to your OMS Player, complete the steps you would to set up a standard OMS Player and ensure it's playing correctly in the viewport. From your Content Browser, add your OMS file into your OMS Player folder. You will be generating skeletal information from the OMS file along with several other assets. It's best practice to keep all of these assets together. If you’ve transformed your OMS Player actor in any way, ensure that your animation blueprint has the transforms also applied to match the transforms of your OMS player Blueprint. ### Adding skeletal mesh and bones: ```eval_rst .. image:: assets/UnrealretargetingSkeletonassets.PNG :width: 2000 ``` OMS playback with head retargeting requires a skinned mesh and skeleton data to control your actor’s motions. These are generated from an OMS file containing embedded rigging data. To generate a new SkeletalMesh, right click on your OMS file and select Create Retarget SkeletalMesh. Next, right-click on the newly created SkeletalMesh and under Skeleton, click Create Skeleton. You should rename these appropriately, as both the mesh and skeleton assets require specific configurations. ### Retargeting Blueprint: Adding an Animation Blueprint is what enables head retargeting to lock onto a target object and control your actor’s head motion during playback. For example, you can add a Look At blueprint using the following steps: In your OMS_Player folder, right-click to create a new asset, and select the Animation Blueprint from the Animation dropdown menu. Open the newly created Animation Blueprint to expose the AnimGraph window. Here you will see an empty Output Pose as default. ```eval_rst .. image:: assets/unrealretargetinglookatnodeplacement.PNG :width: 2000 ``` In an empty space in the AnimGraph, right-click and create a Look At node and connect its output to the Result of the Output Pose. With the Look At node selected, update its Details as follows: - Update its Bone to Modify to ‘head’ - Change its Look at Axis values to 0.0, 0.0, 1.0 - Compile and Save the Animation Blueprint With the initial animation configurations made, you can drag your Animation Blueprint into your Level with the OMS_Mesh_Blueprint you created. It’s important you update the Animation Blueprint's position, rotation, and scale values to match your OMS_Mesh_Blueprint. Ensure that Retargeting Enable is selected in your OMS_Mesh_Blueprint’s Details panel. ```eval_rst .. image:: assets/unrealretargetingenableretargeting.PNG :width: 2000 ``` ### Adding a look at object Create an object to direct where your actor's head will look. Place a primitive object in the scene--like a sphere--and position it to where you would like your actor to look. Note that you will want to reduce the size of the object. In the Animation Blueprint, select the **Look At node** and in its Details panel, enable the **Look At Location** in the Target tab. ```eval_rst .. image:: assets/Unrealretargetinglookatnodeparams.PNG :width: 2000 ``` This will expose the **Look At parameters** in the AnimGraph. Next, create a variable to use as the look at location--name this ‘LookAtLocation’--and set its variable type to **Vector**. ```eval_rst .. image:: assets/unreallookattargetgetter.PNG :width: 2000 ``` Drag your LookAtLocation variable in the AnimGraph as a Get and connect it to the Look At Location input of the Look At node. Switch over to the Event Graph of the Animation Blueprint. Add the following assets and connections between the nodes: ```eval_rst .. image:: assets/unreallookateventgraph.PNG :width: 2000 ``` 1. Create a Get All Actors with Tag function; in the node’s Tag field, add LookAtTarget (you will add this tag to your primitive look at object as well) 2. Click on the Get All Actors with Tag Out Actors output and create a Get node 3. Click on the Get node’s output and create a Get Actor node 4. Drag the LookAtLocation variable into the Event Graph and make it a Set 5. Connect the GetActorLocation node’s Return Value output with the LookAtLocation variable’s Look at Location input 6. Connect the Get All Actors with Tag node’s Exec output to the LookAtLocation variable’s Exec input 7. Drag the existing Event Blueprint Update Animation node’s Exec output to the Get All Actors with Tag node’s Exec input 8. Compile and Save your Animation Blueprint Select your primitive ‘look at’ object that you added to your scene. In the object’s Details panel, navigate down to the Actor tab and add a Tag element. In the new field that is created below, add the ‘LookAtTarget’ tag that is shared with the Get All Actors with Tag node. ```eval_rst .. image:: assets/unreallookatmeshdetails.PNG :width: 1600 ``` You can hide your skeletal mesh in the viewport by assigning a custom material to it. In your OMS_Player folder, create a new material. Open the material, set the blending mode in its Details panel to Translucent, create a Constant node in the material editor, and connect it to the material’s Opacity channel. Back in your OMS_Player folder, open your skeletal mesh object and assign the translucent material to the skeletal mesh’s Material Slot.