Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andreacatania/runtimeskeletalmeshgenerator
Helper to load a SkeletalMesh into a SkeletalMeshComponent in UE5 at runtime.
https://github.com/andreacatania/runtimeskeletalmeshgenerator
Last synced: about 20 hours ago
JSON representation
Helper to load a SkeletalMesh into a SkeletalMeshComponent in UE5 at runtime.
- Host: GitHub
- URL: https://github.com/andreacatania/runtimeskeletalmeshgenerator
- Owner: AndreaCatania
- License: mit
- Created: 2021-10-12T08:30:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T11:13:10.000Z (4 months ago)
- Last Synced: 2025-01-17T12:15:25.350Z (8 days ago)
- Language: C++
- Homepage:
- Size: 22.5 KB
- Stars: 74
- Watchers: 3
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Runtime Skeletal Mesh Generator for UE5
Helper to create a SkeletalMeshComponent in UE5 at runtime.
This is a UE5 plugin that simplify the process of creating a `USkeletalMeshComponent`, with many surfaces, at runtime.
You can just pass all the surfaces' data, this library will take care to correctly populate the UE5 buffers, needed to have a fully working `USkeletalMeshComponent`.
## How to use it
To use this library:
1. Add this plugin inside the UE5 game plugins folder.
2. Specify `RuntimeSkeletalMeshGenerator` as plugin on your `Game.uproject`, to enable it.
3. Import the plugin using `#include "RuntimeSkeletalMeshGenerator/RuntimeSkeletalMeshGenerator.h"`
The plugin is ready to be used, here an example on how to use it:
```c++
#include "RuntimeSkeletalMeshGenerator/RuntimeSkeletalMeshGenerator.h"
void YourAmazingFunction()
{
/// ----
/// Populates the passed `SkeletalMesh` with the passed surface data.
/// Make sure to pass a valid `USkeletalMesh`.
FRuntimeSkeletalMeshGenerator::GenerateSkeletalMesh(
SkeletalMesh,
Surfaces,
SurfacesMaterial,
BoneTransformsOverride);
/// ----
/// Creates a new `USkeletalMesh` and a new `USkeletalMeshComponent`.
/// It returns a valid `USkeletalMeshComponent`, with the generated `USkeletalMesh` assigned.
FRuntimeSkeletalMeshGenerator::GenerateSkeletalMeshComponent(
ActorOwner,
Skeleton,
Surfaces,
SurfacesMaterial,
BoneTransformsOverride);
/// ----
/// Creates a new `USkeletalMesh` and assign it to the given `SkeletalMeshComponent`.
FRuntimeSkeletalMeshGenerator::UpdateSkeletalMeshComponent(
SkeletalMeshComponent,
Skeleton,
Surfaces,
SurfacesMaterial,
BoneTransformsOverride);
/// ----
/// Decompose a `USkeletalMesh` to obtain the surfaces array.
/// This API can be thought as the complement of the above
/// three one, by submitting these arrays in one of the three
/// functions you would obtain a new `USkeletalMesh` that
/// would render the same mesh.
TArray OutSurfaces; // The out Surfaces data that compose the `USkeletalMesh`.
TArray OutSurfacesVertexOffsets; // The vertex offsets for each surface, relative to the passed `SkeletalMesh`: This is useful just in case you need to reconstruct the vertex index used on the `USkeletalMesh`.
TArray OutSurfacesIndexOffsets; // The index offsets for each surface, relative to the passed `SkeletalMesh`: This is useful just in case you need to reconstruct the vertex index used on the `USkeletalMesh`.
TArray OutSurfacesMaterial; // The Materials used.
FRuntimeSkeletalMeshGenerator::DecomposeSkeletalMesh(
SkeletalMesh,
TArray& OutSurfaces,
TArray& OutSurfacesVertexOffsets,
TArray& OutSurfacesIndexOffsets,
TArray& OutSurfacesMaterial);
}
```
## Support
If you need any help, please post a question on the [Discussions page](https://github.com/AndreaCatania/RuntimeSkeletalMeshGenerator/discussions); and if you find a bug please consider to report it on the [Issues page](https://github.com/AndreaCatania/RuntimeSkeletalMeshGenerator/issues)
---
Authors:
- https://github.com/RevoluPowered
- https://github.com/AndreaCatania
- https://github.com/AiMiDi
License MIT
Kindly sponsored by IMVU