@3dsource/angular-unreal-module 0.0.38-dev.2 → 0.0.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +14 -14
- package/README.md +107 -107
- package/fesm2022/3dsource-angular-unreal-module.mjs +96 -55
- package/fesm2022/3dsource-angular-unreal-module.mjs.map +1 -1
- package/index.d.ts +18 -4
- package/index.d.ts.map +1 -0
- package/package.json +3 -3
package/LICENSE
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
Copyright (c) 2025 3dsource
|
|
2
|
-
All Rights Reserved.
|
|
3
|
-
|
|
4
|
-
This software and associated documentation files (the “Software”) are proprietary
|
|
5
|
-
and confidential. Unauthorized copying, modification, distribution, or any other
|
|
6
|
-
use of the Software, in whole or in part, without the prior written consent of
|
|
7
|
-
the copyright holder is strictly prohibited.
|
|
8
|
-
|
|
9
|
-
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
10
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
11
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
|
12
|
-
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
13
|
-
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
14
|
-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
1
|
+
Copyright (c) 2025 3dsource
|
|
2
|
+
All Rights Reserved.
|
|
3
|
+
|
|
4
|
+
This software and associated documentation files (the “Software”) are proprietary
|
|
5
|
+
and confidential. Unauthorized copying, modification, distribution, or any other
|
|
6
|
+
use of the Software, in whole or in part, without the prior written consent of
|
|
7
|
+
the copyright holder is strictly prohibited.
|
|
8
|
+
|
|
9
|
+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
10
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
11
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
|
12
|
+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
13
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
14
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,107 +1,107 @@
|
|
|
1
|
-
# @3dsource/angular-unreal-module
|
|
2
|
-
|
|
3
|
-
A standalone Angular component for integrating Unreal Engine scenes into web applications. This module facilitates
|
|
4
|
-
communication between Angular applications and Unreal Engine, enabling interactive 3D experiences.
|
|
5
|
-
|
|
6
|
-
## Overview
|
|
7
|
-
|
|
8
|
-
The Angular Unreal Module provides:
|
|
9
|
-
|
|
10
|
-
- Seamless integration of Unreal Engine content in Angular applications
|
|
11
|
-
- Communication bridge between Angular and Unreal Engine
|
|
12
|
-
- State management for 3D scene interactions
|
|
13
|
-
- Configurators for customizing Unreal Engine applications
|
|
14
|
-
|
|
15
|
-
## Installation
|
|
16
|
-
|
|
17
|
-
### Prerequisites
|
|
18
|
-
|
|
19
|
-
- Angular 19+
|
|
20
|
-
- NgRx store and effects
|
|
21
|
-
|
|
22
|
-
### Peer Dependencies
|
|
23
|
-
|
|
24
|
-
This library requires the following peer dependencies:
|
|
25
|
-
|
|
26
|
-
```json
|
|
27
|
-
{
|
|
28
|
-
"@3dsource/source-ui-native": "^1.0.7",
|
|
29
|
-
"@3dsource/types-unreal": "^0.0.1",
|
|
30
|
-
"@3dsource/utils": "^1.0.13",
|
|
31
|
-
"@angular/cdk": "^19.2.0",
|
|
32
|
-
"@angular/common": "^19.2.0",
|
|
33
|
-
"@angular/core": "^19.2.0",
|
|
34
|
-
"@angular/forms": "^19.2.0",
|
|
35
|
-
"@ngrx/effects": "^19.1.0",
|
|
36
|
-
"@ngrx/operators": "^19.1.0",
|
|
37
|
-
"@ngrx/store": "^19.1.0"
|
|
38
|
-
}
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### Library Installation
|
|
42
|
-
|
|
43
|
-
```shell
|
|
44
|
-
npm i @3dsource/angular-unreal-module
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
## Usage
|
|
48
|
-
|
|
49
|
-
### Basic Integration
|
|
50
|
-
|
|
51
|
-
1. Import the UnrealModule in your Angular application:
|
|
52
|
-
|
|
53
|
-
```typescript
|
|
54
|
-
import { UnrealModule } from '@3dsource/angular-unreal-module';
|
|
55
|
-
|
|
56
|
-
@NgModule({
|
|
57
|
-
imports: [
|
|
58
|
-
UnrealModule.forRoot({
|
|
59
|
-
// Configuration options
|
|
60
|
-
}),
|
|
61
|
-
],
|
|
62
|
-
})
|
|
63
|
-
export class AppModule {}
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
2. Use the Unreal scene component in your templates:
|
|
67
|
-
|
|
68
|
-
```html
|
|
69
|
-
<unreal-scene [config]="unrealConfig" (sceneReady)="onSceneReady($event)"> </unreal-scene>
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
### Communication with Unreal Engine
|
|
73
|
-
|
|
74
|
-
The module provides services for sending commands to and receiving events from Unreal Engine:
|
|
75
|
-
|
|
76
|
-
```typescript
|
|
77
|
-
import { UnrealService } from '@3dsource/angular-unreal-module';
|
|
78
|
-
|
|
79
|
-
@Component({ ... })
|
|
80
|
-
export class MyComponent {
|
|
81
|
-
constructor(private unrealService: UnrealService) {
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
sendCommand() {
|
|
85
|
-
this.unrealService.sendCommand({
|
|
86
|
-
command: 'SomeCommand',
|
|
87
|
-
parameters: { /* command parameters */ }
|
|
88
|
-
});
|
|
89
|
-
}
|
|
90
|
-
}
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
## Features
|
|
94
|
-
|
|
95
|
-
- **Unreal Scene Component**: Embed Unreal Engine content in Angular applications
|
|
96
|
-
- **Command API**: Send commands to Unreal Engine
|
|
97
|
-
- **Event Handling**: React to events from Unreal Engine
|
|
98
|
-
- **State Management**: NgRx integration for managing 3D scene state
|
|
99
|
-
- **Configuration Options**: Customize the Unreal Engine integration
|
|
100
|
-
|
|
101
|
-
## Examples
|
|
102
|
-
|
|
103
|
-
Check the demo application for complete usage examples:
|
|
104
|
-
|
|
105
|
-
```shell
|
|
106
|
-
npm run demo:start
|
|
107
|
-
```
|
|
1
|
+
# @3dsource/angular-unreal-module
|
|
2
|
+
|
|
3
|
+
A standalone Angular component for integrating Unreal Engine scenes into web applications. This module facilitates
|
|
4
|
+
communication between Angular applications and Unreal Engine, enabling interactive 3D experiences.
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
The Angular Unreal Module provides:
|
|
9
|
+
|
|
10
|
+
- Seamless integration of Unreal Engine content in Angular applications
|
|
11
|
+
- Communication bridge between Angular and Unreal Engine
|
|
12
|
+
- State management for 3D scene interactions
|
|
13
|
+
- Configurators for customizing Unreal Engine applications
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
### Prerequisites
|
|
18
|
+
|
|
19
|
+
- Angular 19+
|
|
20
|
+
- NgRx store and effects
|
|
21
|
+
|
|
22
|
+
### Peer Dependencies
|
|
23
|
+
|
|
24
|
+
This library requires the following peer dependencies:
|
|
25
|
+
|
|
26
|
+
```json
|
|
27
|
+
{
|
|
28
|
+
"@3dsource/source-ui-native": "^1.0.7",
|
|
29
|
+
"@3dsource/types-unreal": "^0.0.1",
|
|
30
|
+
"@3dsource/utils": "^1.0.13",
|
|
31
|
+
"@angular/cdk": "^19.2.0",
|
|
32
|
+
"@angular/common": "^19.2.0",
|
|
33
|
+
"@angular/core": "^19.2.0",
|
|
34
|
+
"@angular/forms": "^19.2.0",
|
|
35
|
+
"@ngrx/effects": "^19.1.0",
|
|
36
|
+
"@ngrx/operators": "^19.1.0",
|
|
37
|
+
"@ngrx/store": "^19.1.0"
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Library Installation
|
|
42
|
+
|
|
43
|
+
```shell
|
|
44
|
+
npm i @3dsource/angular-unreal-module
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Usage
|
|
48
|
+
|
|
49
|
+
### Basic Integration
|
|
50
|
+
|
|
51
|
+
1. Import the UnrealModule in your Angular application:
|
|
52
|
+
|
|
53
|
+
```typescript
|
|
54
|
+
import { UnrealModule } from '@3dsource/angular-unreal-module';
|
|
55
|
+
|
|
56
|
+
@NgModule({
|
|
57
|
+
imports: [
|
|
58
|
+
UnrealModule.forRoot({
|
|
59
|
+
// Configuration options
|
|
60
|
+
}),
|
|
61
|
+
],
|
|
62
|
+
})
|
|
63
|
+
export class AppModule {}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
2. Use the Unreal scene component in your templates:
|
|
67
|
+
|
|
68
|
+
```html
|
|
69
|
+
<unreal-scene [config]="unrealConfig" (sceneReady)="onSceneReady($event)"> </unreal-scene>
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Communication with Unreal Engine
|
|
73
|
+
|
|
74
|
+
The module provides services for sending commands to and receiving events from Unreal Engine:
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import { UnrealService } from '@3dsource/angular-unreal-module';
|
|
78
|
+
|
|
79
|
+
@Component({ ... })
|
|
80
|
+
export class MyComponent {
|
|
81
|
+
constructor(private unrealService: UnrealService) {
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
sendCommand() {
|
|
85
|
+
this.unrealService.sendCommand({
|
|
86
|
+
command: 'SomeCommand',
|
|
87
|
+
parameters: { /* command parameters */ }
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Features
|
|
94
|
+
|
|
95
|
+
- **Unreal Scene Component**: Embed Unreal Engine content in Angular applications
|
|
96
|
+
- **Command API**: Send commands to Unreal Engine
|
|
97
|
+
- **Event Handling**: React to events from Unreal Engine
|
|
98
|
+
- **State Management**: NgRx integration for managing 3D scene state
|
|
99
|
+
- **Configuration Options**: Customize the Unreal Engine integration
|
|
100
|
+
|
|
101
|
+
## Examples
|
|
102
|
+
|
|
103
|
+
Check the demo application for complete usage examples:
|
|
104
|
+
|
|
105
|
+
```shell
|
|
106
|
+
npm run demo:start
|
|
107
|
+
```
|