-
Notifications
You must be signed in to change notification settings - Fork 75
/
HoudiniEngine.cpp
1344 lines (1135 loc) · 39.9 KB
/
HoudiniEngine.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) <2021> Side Effects Software Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. The name of Side Effects Software may not be used to endorse or
* promote products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY SIDE EFFECTS SOFTWARE "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
* NO EVENT SHALL SIDE EFFECTS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "HoudiniEngine.h"
#include "HoudiniEnginePrivatePCH.h"
#include "HoudiniApi.h"
#include "HoudiniEngineUtils.h"
#include "HoudiniEngineRuntimeUtils.h"
#include "HoudiniRuntimeSettings.h"
#include "HoudiniEngineScheduler.h"
#include "HoudiniEngineManager.h"
#include "HoudiniEngineRuntime.h"
#include "HoudiniEngineTask.h"
#include "HoudiniEngineTaskInfo.h"
#include "HoudiniAssetComponent.h"
#include "HAPI/HAPI_Version.h"
#include "Modules/ModuleManager.h"
#include "Misc/ScopeLock.h"
#include "Engine/StaticMesh.h"
#include "Materials/Material.h"
#include "ISettingsModule.h"
#include "HAL/PlatformFileManager.h"
#include "Async/Async.h"
#include "Logging/LogMacros.h"
#if WITH_EDITOR
#include "Widgets/Notifications/SNotificationList.h"
#include "Framework/Notifications/NotificationManager.h"
#endif
#define LOCTEXT_NAMESPACE "HoudiniEngine"
IMPLEMENT_MODULE(FHoudiniEngine, HoudiniEngine)
DEFINE_LOG_CATEGORY( LogHoudiniEngine );
FHoudiniEngine *
FHoudiniEngine::HoudiniEngineInstance = nullptr;
FHoudiniEngine::FHoudiniEngine()
: LicenseType(HAPI_LICENSE_NONE)
, HoudiniEngineSchedulerThread(nullptr)
, HoudiniEngineScheduler(nullptr)
, HoudiniEngineManagerThread(nullptr)
, HoudiniEngineManager(nullptr)
//, bHAPIVersionMismatch(false)
, bEnableCookingGlobal(true)
, UIRefreshCountWhenPauseCooking(0)
, bFirstSessionCreated(false)
, bEnableSessionSync(false)
, bCookUsingHoudiniTime(true)
, bSyncViewport(false)
, bSyncHoudiniViewport(true)
, bSyncUnrealViewport(false)
, HoudiniLogoStaticMesh(nullptr)
, HoudiniDefaultMaterial(nullptr)
, HoudiniTemplateMaterial(nullptr)
, HoudiniLogoBrush(nullptr)
, HoudiniDefaultReferenceMesh(nullptr)
, HoudiniDefaultReferenceMeshMaterial(nullptr)
{
Session.type = HAPI_SESSION_MAX;
Session.id = -1;
SetSessionStatus(EHoudiniSessionStatus::Invalid);
#if WITH_EDITOR
HapiNotificationStarted = 0.0;
TimeSinceLastPersistentNotification = 0.0;
#endif
}
FHoudiniEngine&
FHoudiniEngine::Get()
{
check(FHoudiniEngine::HoudiniEngineInstance);
return *FHoudiniEngine::HoudiniEngineInstance;
}
bool
FHoudiniEngine::IsInitialized()
{
return FHoudiniEngine::HoudiniEngineInstance != nullptr && FHoudiniEngineUtils::IsInitialized();
}
void
FHoudiniEngine::StartupModule()
{
HOUDINI_LOG_MESSAGE(TEXT("Starting the Houdini Engine module..."));
#if WITH_EDITOR
// Register settings.
if (ISettingsModule * SettingsModule = FModuleManager::GetModulePtr<ISettingsModule>("Settings"))
{
SettingsModule->RegisterSettings(
"Project", "Plugins", "HoudiniEngine",
LOCTEXT("RuntimeSettingsName", "Houdini Engine"),
LOCTEXT("RuntimeSettingsDescription", "Configure the HoudiniEngine plugin"),
GetMutableDefault< UHoudiniRuntimeSettings >());
}
#endif
// Before starting the module, we need to locate and load HAPI library.
{
void * HAPILibraryHandle = FHoudiniEngineUtils::LoadLibHAPI(LibHAPILocation);
if ( HAPILibraryHandle )
{
FHoudiniApi::InitializeHAPI( HAPILibraryHandle );
}
else
{
// Get platform specific name of libHAPI.
FString LibHAPIName = FHoudiniEngineRuntimeUtils::GetLibHAPIName();
HOUDINI_LOG_MESSAGE(TEXT("Failed locating or loading %s"), *LibHAPIName);
}
}
// Create static mesh Houdini logo.
HoudiniLogoStaticMesh = LoadObject<UStaticMesh>(
nullptr, HAPI_UNREAL_RESOURCE_HOUDINI_LOGO, nullptr, LOAD_None, nullptr);
if (HoudiniLogoStaticMesh.IsValid())
HoudiniLogoStaticMesh->AddToRoot();
// Create default material.
HoudiniDefaultMaterial = LoadObject<UMaterial>(
nullptr, HAPI_UNREAL_RESOURCE_HOUDINI_MATERIAL, nullptr, LOAD_None, nullptr);
if (HoudiniDefaultMaterial.IsValid())
HoudiniDefaultMaterial->AddToRoot();
HoudiniTemplateMaterial = LoadObject<UMaterial>(
nullptr, HAPI_UNREAL_RESOURCE_HOUDINI_TEMPLATE_MATERIAL, nullptr, LOAD_None, nullptr);
if (HoudiniTemplateMaterial.IsValid())
HoudiniTemplateMaterial->AddToRoot();
// Houdini Logo Brush
FString Icon128FilePath = FHoudiniEngineUtils::GetHoudiniEnginePluginDir() / TEXT("Resources/Icon128.png");
if (FSlateApplication::IsInitialized() && FPlatformFileManager::Get().GetPlatformFile().FileExists(*Icon128FilePath))
{
const FName BrushName(*Icon128FilePath);
const FIntPoint Size = FSlateApplication::Get().GetRenderer()->GenerateDynamicImageResource(BrushName);
if (Size.X > 0 && Size.Y > 0)
{
static const int32 ProgressIconSize = 32;
HoudiniLogoBrush = MakeShareable(new FSlateDynamicImageBrush(
BrushName, FVector2D(ProgressIconSize, ProgressIconSize)));
}
}
// Houdini Engine Logo Brush
FString HEIcon128FilePath = FHoudiniEngineUtils::GetHoudiniEnginePluginDir() / TEXT("Resources/hengine_logo_128.png");
if (FSlateApplication::IsInitialized() && FPlatformFileManager::Get().GetPlatformFile().FileExists(*HEIcon128FilePath))
{
const FName BrushName(*HEIcon128FilePath);
const FIntPoint Size = FSlateApplication::Get().GetRenderer()->GenerateDynamicImageResource(BrushName);
if (Size.X > 0 && Size.Y > 0)
{
static const int32 ProgressIconSize = 32;
HoudiniEngineLogoBrush = MakeShareable(new FSlateDynamicImageBrush(
BrushName, FVector2D(ProgressIconSize, ProgressIconSize)));
}
}
// Create Houdini default reference mesh
HoudiniDefaultReferenceMesh = LoadObject<UStaticMesh>(
nullptr, HAPI_UNREAL_RESOURCE_HOUDINI_DEFAULT_REFERENCE_MESH, nullptr, LOAD_None, nullptr);
if (HoudiniDefaultReferenceMesh.IsValid())
HoudiniDefaultReferenceMesh->AddToRoot();
// Create Houdini default reference mesh material
HoudiniDefaultReferenceMeshMaterial = LoadObject<UMaterial>
(nullptr, HAPI_UNREAL_RESOURCE_HOUDINI_DEFAULT_REFERENCE_MESH_MATERIAL, nullptr, LOAD_None, nullptr);
if (HoudiniDefaultReferenceMeshMaterial.IsValid())
HoudiniDefaultReferenceMeshMaterial->AddToRoot();
// We do not automatically try to start a session when starting up the module now.
bFirstSessionCreated = false;
// Create HAPI scheduler and processing thread.
HoudiniEngineScheduler = new FHoudiniEngineScheduler();
HoudiniEngineSchedulerThread = FRunnableThread::Create(
HoudiniEngineScheduler, TEXT("HoudiniSchedulerThread"), 0, TPri_Normal);
// Create Houdini Asset Manager
HoudiniEngineManager = new FHoudiniEngineManager();
// Set the session status to Not Started
SetSessionStatus(EHoudiniSessionStatus::NotStarted);
// Set the default value for pausing houdini engine cooking
const UHoudiniRuntimeSettings * HoudiniRuntimeSettings = GetDefault<UHoudiniRuntimeSettings>();
bEnableCookingGlobal = !HoudiniRuntimeSettings->bPauseCookingOnStart;
// Check if a null session is set
bool bNoneSession = (HoudiniRuntimeSettings->SessionType == EHoudiniRuntimeSettingsSessionType::HRSST_None);
if (bNoneSession)
SetSessionStatus(EHoudiniSessionStatus::None);
// Initialize the singleton with this instance
FHoudiniEngine::HoudiniEngineInstance = this;
// See if we need to start the manager ticking if needed
// Dont tick if we failed to load HAPI, if cooking is disabled or if we're using a null session
if (FHoudiniApi::IsHAPIInitialized())
{
if (bEnableCookingGlobal && !bNoneSession)
{
PostEngineInitCallback = FCoreDelegates::OnPostEngineInit.AddLambda([]()
{
FHoudiniEngine& HEngine = FHoudiniEngine::Get();
HEngine.UnregisterPostEngineInitCallback();
FHoudiniEngineManager* const Manager = HEngine.GetHoudiniEngineManager();
if (Manager)
Manager->StartHoudiniTicking();
});
}
}
}
void
FHoudiniEngine::ShutdownModule()
{
HOUDINI_LOG_MESSAGE(TEXT("Shutting down the Houdini Engine module."));
// We no longer need the Houdini logo static mesh.
if (HoudiniLogoStaticMesh.IsValid())
{
HoudiniLogoStaticMesh->RemoveFromRoot();
HoudiniLogoStaticMesh = nullptr;
}
// We no longer need the Houdini default material.
if (HoudiniDefaultMaterial.IsValid())
{
HoudiniDefaultMaterial->RemoveFromRoot();
HoudiniDefaultMaterial = nullptr;
}
// We no longer need the Houdini default material.
if (HoudiniTemplateMaterial.IsValid())
{
HoudiniTemplateMaterial->RemoveFromRoot();
HoudiniTemplateMaterial = nullptr;
}
// We no longer need the Houdini default reference mesh
if (HoudiniDefaultReferenceMesh.IsValid())
{
HoudiniDefaultReferenceMesh->RemoveFromRoot();
HoudiniDefaultReferenceMesh = nullptr;
}
// We no longer need the Houdini default reference mesh material
if (HoudiniDefaultReferenceMeshMaterial.IsValid())
{
HoudiniDefaultReferenceMeshMaterial->RemoveFromRoot();
HoudiniDefaultReferenceMeshMaterial = nullptr;
}
/*
// We no longer need Houdini digital asset used for loading bgeo files.
if (HoudiniBgeoAsset.IsValid())
{
HoudiniBgeoAsset->RemoveFromRoot();
HoudiniBgeoAsset = nullptr;
}
*/
#if WITH_EDITOR
// Unregister settings.
ISettingsModule * SettingsModule = FModuleManager::GetModulePtr<ISettingsModule>("Settings");
if (SettingsModule)
SettingsModule->UnregisterSettings("Project", "Plugins", "HoudiniEngine");
#endif
// Do scheduler and thread clean up.
if (HoudiniEngineScheduler)
HoudiniEngineScheduler->Stop();
if (HoudiniEngineSchedulerThread)
{
//HoudiniEngineSchedulerThread->Kill( true );
HoudiniEngineSchedulerThread->WaitForCompletion();
delete HoudiniEngineSchedulerThread;
HoudiniEngineSchedulerThread = nullptr;
}
if ( HoudiniEngineScheduler )
{
delete HoudiniEngineScheduler;
HoudiniEngineScheduler = nullptr;
}
// Do manager clean up.
if (HoudiniEngineManager)
HoudiniEngineManager->StopHoudiniTicking();
if (HoudiniEngineManager)
{
delete HoudiniEngineManager;
HoudiniEngineManager = nullptr;
}
// Perform HAPI finalization.
if ( FHoudiniApi::IsHAPIInitialized() )
{
FHoudiniApi::Cleanup(GetSession());
FHoudiniApi::CloseSession(GetSession());
SessionStatus = EHoudiniSessionStatus::Invalid;
}
FHoudiniApi::FinalizeHAPI();
FHoudiniEngine::HoudiniEngineInstance = nullptr;
}
void
FHoudiniEngine::AddTask(const FHoudiniEngineTask & InTask)
{
if ( HoudiniEngineScheduler )
HoudiniEngineScheduler->AddTask(InTask);
FScopeLock ScopeLock(&CriticalSection);
FHoudiniEngineTaskInfo TaskInfo;
TaskInfo.TaskType = InTask.TaskType;
TaskInfo.TaskState = EHoudiniEngineTaskState::Working;
TaskInfos.Add(InTask.HapiGUID, TaskInfo);
}
void
FHoudiniEngine::AddTaskInfo(const FGuid& InHapiGUID, const FHoudiniEngineTaskInfo & InTaskInfo)
{
FScopeLock ScopeLock(&CriticalSection);
TaskInfos.Add(InHapiGUID, InTaskInfo);
}
void
FHoudiniEngine::RemoveTaskInfo(const FGuid& InHapiGUID)
{
FScopeLock ScopeLock(&CriticalSection);
TaskInfos.Remove(InHapiGUID);
}
bool
FHoudiniEngine::RetrieveTaskInfo(const FGuid& InHapiGUID, FHoudiniEngineTaskInfo & OutTaskInfo)
{
FScopeLock ScopeLock(&CriticalSection);
if (TaskInfos.Contains(InHapiGUID))
{
OutTaskInfo = TaskInfos[InHapiGUID];
return true;
}
return false;
}
/*
void
FHoudiniEngine::AddHoudiniAssetComponent(UHoudiniAssetComponent* HAC)
{
if (!IsValid(HAC))
return;
if (HoudiniEngineManager)
HoudiniEngineManager->AddComponent(HAC);
}
*/
const FString &
FHoudiniEngine::GetLibHAPILocation() const
{
return LibHAPILocation;
}
const FString
FHoudiniEngine::GetHoudiniExecutable()
{
FString HoudiniExecutable = TEXT("houdini");
const UHoudiniRuntimeSettings * HoudiniRuntimeSettings = GetDefault<UHoudiniRuntimeSettings>();
if (HoudiniRuntimeSettings)
{
switch (HoudiniRuntimeSettings->HoudiniExecutable)
{
case EHoudiniExecutableType::HRSHE_HoudiniFX:
HoudiniExecutable = TEXT("houdinifx");
break;
case EHoudiniExecutableType::HRSHE_HoudiniCore:
HoudiniExecutable = TEXT("houdinicore");
break;
case EHoudiniExecutableType::HRSHE_HoudiniIndie:
HoudiniExecutable = TEXT("hindie");
break;
default:
case EHoudiniExecutableType::HRSHE_Houdini:
HoudiniExecutable = TEXT("houdini");
break;
}
}
return HoudiniExecutable;
}
const HAPI_Session *
FHoudiniEngine::GetSession() const
{
return Session.type == HAPI_SESSION_MAX ? nullptr : &Session;
}
const EHoudiniSessionStatus&
FHoudiniEngine::GetSessionStatus() const
{
return SessionStatus;
}
void
FHoudiniEngine::SetSessionStatus(const EHoudiniSessionStatus& InSessionStatus)
{
const UHoudiniRuntimeSettings * HoudiniRuntimeSettings = GetDefault<UHoudiniRuntimeSettings>();
if (HoudiniRuntimeSettings->SessionType == EHoudiniRuntimeSettingsSessionType::HRSST_None)
{
// Check for none sessions first
SessionStatus = EHoudiniSessionStatus::None;
return;
}
if (!bFirstSessionCreated)
{
// Don't change the status unless we've attempted to start the session once
SessionStatus = EHoudiniSessionStatus::NotStarted;
return;
}
switch (InSessionStatus)
{
case EHoudiniSessionStatus::NotStarted:
case EHoudiniSessionStatus::NoLicense:
case EHoudiniSessionStatus::Lost:
case EHoudiniSessionStatus::None:
case EHoudiniSessionStatus::Invalid:
case EHoudiniSessionStatus::Connected:
{
SessionStatus = InSessionStatus;
}
break;
case EHoudiniSessionStatus::Stopped:
{
// Only set to stop status if the session was valid
if (SessionStatus == EHoudiniSessionStatus::Connected)
SessionStatus = EHoudiniSessionStatus::Stopped;
}
break;
case EHoudiniSessionStatus::Failed:
{
// Preserve No License / Lost status
if (SessionStatus != EHoudiniSessionStatus::NoLicense && SessionStatus != EHoudiniSessionStatus::Lost)
SessionStatus = EHoudiniSessionStatus::Failed;
}
break;
}
}
HAPI_CookOptions
FHoudiniEngine::GetDefaultCookOptions()
{
// Default CookOptions
HAPI_CookOptions CookOptions;
FHoudiniApi::CookOptions_Init(&CookOptions);
CookOptions.curveRefineLOD = 8.0f;
CookOptions.clearErrorsAndWarnings = false;
CookOptions.maxVerticesPerPrimitive = 3;
CookOptions.splitGeosByGroup = false;
CookOptions.splitGeosByAttribute = false;
CookOptions.splitAttrSH = 0;
CookOptions.refineCurveToLinear = true;
CookOptions.handleBoxPartTypes = false;
CookOptions.handleSpherePartTypes = false;
CookOptions.splitPointsByVertexAttributes = false;
CookOptions.packedPrimInstancingMode = HAPI_PACKEDPRIM_INSTANCING_MODE_FLAT;
CookOptions.cookTemplatedGeos = true;
return CookOptions;
}
bool
FHoudiniEngine::StartSession(HAPI_Session*& SessionPtr,
const bool& StartAutomaticServer,
const float& AutomaticServerTimeout,
const EHoudiniRuntimeSettingsSessionType& SessionType,
const FString& ServerPipeName,
const int32& ServerPort,
const FString& ServerHost)
{
// HAPI needs to be initialized
if (!FHoudiniApi::IsHAPIInitialized())
return false;
// Only start a new Session if we dont already have a valid one
if (HAPI_RESULT_SUCCESS == FHoudiniApi::IsSessionValid(SessionPtr))
return true;
// Set the HAPI_CLIENT_NAME environment variable to "unreal"
// We need to do this before starting HARS.
FPlatformMisc::SetEnvironmentVar(TEXT("HAPI_CLIENT_NAME"), TEXT("unreal"));
HAPI_Result SessionResult = HAPI_RESULT_FAILURE;
HAPI_ThriftServerOptions ServerOptions;
FMemory::Memzero< HAPI_ThriftServerOptions >(ServerOptions);
ServerOptions.autoClose = true;
ServerOptions.timeoutMs = AutomaticServerTimeout;
// Unless we automatically start the server,
// consider we're in SessionSync mode
bEnableSessionSync = true;
auto UpdatePathForServer = [&]
{
// Modify our PATH so that HARC will find HARS.exe
const TCHAR* PathDelimiter = FPlatformMisc::GetPathVarDelimiter();
FString OrigPathVar = FPlatformMisc::GetEnvironmentVariable(TEXT("PATH"));
FString ModifiedPath =
#if PLATFORM_MAC
// On Mac our binaries are split between two folders
LibHAPILocation + TEXT("/../Resources/bin") + PathDelimiter +
#endif
LibHAPILocation + PathDelimiter + OrigPathVar;
FPlatformMisc::SetEnvironmentVar(TEXT("PATH"), *ModifiedPath);
};
// Clear the connection error before starting a new session
if(SessionType != EHoudiniRuntimeSettingsSessionType::HRSST_None)
FHoudiniApi::ClearConnectionError();
switch (SessionType)
{
case EHoudiniRuntimeSettingsSessionType::HRSST_Socket:
{
// Try to connect to an existing socket session first
SessionResult = FHoudiniApi::CreateThriftSocketSession(
SessionPtr, TCHAR_TO_UTF8(*ServerHost), ServerPort );
// Start a session and try to connect to it if we failed
if ( StartAutomaticServer && SessionResult != HAPI_RESULT_SUCCESS )
{
UpdatePathForServer();
FHoudiniApi::StartThriftSocketServer(
&ServerOptions, ServerPort, nullptr);
// We've started the server manually, disable session sync
bEnableSessionSync = false;
SessionResult = FHoudiniApi::CreateThriftSocketSession(
SessionPtr, TCHAR_TO_UTF8(*ServerHost), ServerPort);
}
}
break;
case EHoudiniRuntimeSettingsSessionType::HRSST_NamedPipe:
{
// Try to connect to an existing pipe session first
SessionResult = FHoudiniApi::CreateThriftNamedPipeSession(
SessionPtr, TCHAR_TO_UTF8(*ServerPipeName) );
// Start a session and try to connect to it if we failed
if (StartAutomaticServer && SessionResult != HAPI_RESULT_SUCCESS)
{
UpdatePathForServer();
FHoudiniApi::StartThriftNamedPipeServer(
&ServerOptions, TCHAR_TO_UTF8(*ServerPipeName), nullptr);
// We've started the server manually, disable session sync
bEnableSessionSync = false;
SessionResult = FHoudiniApi::CreateThriftNamedPipeSession(
SessionPtr, TCHAR_TO_UTF8(*ServerPipeName));
}
}
break;
case EHoudiniRuntimeSettingsSessionType::HRSST_None:
{
HOUDINI_LOG_MESSAGE(TEXT("Session type set to None, Cooking is disabled."));
// Disable session sync
bEnableSessionSync = false;
break;
}
case EHoudiniRuntimeSettingsSessionType::HRSST_InProcess:
// As of Unreal 4.19, InProcess sessions are not supported anymore
SessionResult = FHoudiniApi::CreateInProcessSession(SessionPtr);
// Disable session sync
bEnableSessionSync = false;
break;
default:
HOUDINI_LOG_ERROR(TEXT("Unsupported Houdini Engine session type"));
// Disable session sync
bEnableSessionSync = false;
break;
}
// Stop here if we used a none session
if (SessionType == EHoudiniRuntimeSettingsSessionType::HRSST_None)
return false;
FHoudiniEngine::Get().SetFirstSessionCreated(true);
if (SessionResult != HAPI_RESULT_SUCCESS || !SessionPtr)
{
// Disable session sync as well?
bEnableSessionSync = false;
if (SessionType != EHoudiniRuntimeSettingsSessionType::HRSST_InProcess)
{
FString ConnectionError = FHoudiniEngineUtils::GetConnectionError();
if(!ConnectionError.IsEmpty())
HOUDINI_LOG_ERROR(TEXT("Houdini Engine Session failed to connect - %s"), *ConnectionError);
}
return false;
}
// Update this session's license type
HOUDINI_CHECK_ERROR(FHoudiniApi::GetSessionEnvInt(
SessionPtr, HAPI_SESSIONENVINT_LICENSE, (int32 *)&LicenseType));
return true;
}
bool
FHoudiniEngine::SessionSyncConnect(
const EHoudiniRuntimeSettingsSessionType& SessionType,
const FString& ServerPipeName,
const FString& ServerHost,
const int32& ServerPort)
{
// HAPI needs to be initialized
if (!FHoudiniApi::IsHAPIInitialized())
return false;
// Only start a new Session if we dont already have a valid one
if (HAPI_RESULT_SUCCESS == FHoudiniApi::IsSessionValid(&Session))
return true;
// Consider the session failed as long as we dont connect
SetSessionStatus(EHoudiniSessionStatus::Failed);
HAPI_Result SessionResult = HAPI_RESULT_FAILURE;
const UHoudiniRuntimeSettings * HoudiniRuntimeSettings = GetDefault<UHoudiniRuntimeSettings>();
HAPI_ThriftServerOptions ServerOptions;
FMemory::Memzero< HAPI_ThriftServerOptions >(ServerOptions);
ServerOptions.autoClose = true;
ServerOptions.timeoutMs = HoudiniRuntimeSettings->AutomaticServerTimeout;
switch (SessionType)
{
case EHoudiniRuntimeSettingsSessionType::HRSST_Socket:
{
// Try to connect to an existing socket session first
SessionResult = FHoudiniApi::CreateThriftSocketSession(
&Session, TCHAR_TO_UTF8(*ServerHost), ServerPort);
}
break;
case EHoudiniRuntimeSettingsSessionType::HRSST_NamedPipe:
{
// Try to connect to an existing pipe session first
SessionResult = FHoudiniApi::CreateThriftNamedPipeSession(
&Session, TCHAR_TO_UTF8(*ServerPipeName));
}
break;
case EHoudiniRuntimeSettingsSessionType::HRSST_None:
case EHoudiniRuntimeSettingsSessionType::HRSST_InProcess:
default:
HOUDINI_LOG_ERROR(TEXT("Unsupported Houdini Engine Session Sync Type!!"));
bEnableSessionSync = false;
break;
}
if (SessionResult != HAPI_RESULT_SUCCESS)
return false;
// Enable session sync
bEnableSessionSync = true;
SetSessionStatus(EHoudiniSessionStatus::Connected);
// Update this session's license type
HOUDINI_CHECK_ERROR(FHoudiniApi::GetSessionEnvInt(
&Session, HAPI_SESSIONENVINT_LICENSE, (int32 *)&LicenseType));
// Update the default viewport sync settings
bSyncViewport = HoudiniRuntimeSettings->bSyncViewport;
bSyncHoudiniViewport = HoudiniRuntimeSettings->bSyncHoudiniViewport;
bSyncUnrealViewport = HoudiniRuntimeSettings->bSyncUnrealViewport;
return true;
}
bool
FHoudiniEngine::InitializeHAPISession()
{
// The HAPI stubs needs to be initialized
if (!FHoudiniApi::IsHAPIInitialized())
{
HOUDINI_LOG_ERROR(TEXT("Failed to initialize HAPI: The Houdini API stubs have not been properly initialized."));
return false;
}
// We need a Valid Session
if (HAPI_RESULT_SUCCESS != FHoudiniApi::IsSessionValid(GetSession()))
{
HOUDINI_LOG_ERROR(TEXT("Failed to initialize HAPI: The session is invalid."));
return false;
}
// Now, initialize HAPI with the new session
// We need to make sure HAPI version is correct.
int32 RunningEngineMajor = 0;
int32 RunningEngineMinor = 0;
int32 RunningEngineApi = 0;
// Retrieve version numbers for running Houdini Engine.
FHoudiniApi::GetEnvInt(HAPI_ENVINT_VERSION_HOUDINI_ENGINE_MAJOR, &RunningEngineMajor);
FHoudiniApi::GetEnvInt(HAPI_ENVINT_VERSION_HOUDINI_ENGINE_MINOR, &RunningEngineMinor);
FHoudiniApi::GetEnvInt(HAPI_ENVINT_VERSION_HOUDINI_ENGINE_API, &RunningEngineApi);
// Compare defined and running versions.
if (RunningEngineMajor != HAPI_VERSION_HOUDINI_ENGINE_MAJOR
|| RunningEngineMinor != HAPI_VERSION_HOUDINI_ENGINE_MINOR)
{
// Major or minor HAPI version differs, stop here
HOUDINI_LOG_ERROR(
TEXT("Starting up the Houdini Engine module failed: built and running versions do not match."));
HOUDINI_LOG_ERROR(
TEXT("Defined version: %d.%d.api:%d vs Running version: %d.%d.api:%d"),
HAPI_VERSION_HOUDINI_ENGINE_MAJOR, HAPI_VERSION_HOUDINI_ENGINE_MINOR, HAPI_VERSION_HOUDINI_ENGINE_API,
RunningEngineMajor, RunningEngineMinor, RunningEngineApi);
// Display an error message
//
return false;
}
else if (RunningEngineApi != HAPI_VERSION_HOUDINI_ENGINE_API)
{
// Major/minor HAPIversions match, but only the API version differs,
// Allow the user to continue but warn him of possible instabilities
HOUDINI_LOG_WARNING(
TEXT("Starting up the Houdini Engine module: built and running versions do not match."));
HOUDINI_LOG_WARNING(
TEXT("Defined version: %d.%d.api:%d vs Running version: %d.%d.api:%d"),
HAPI_VERSION_HOUDINI_ENGINE_MAJOR, HAPI_VERSION_HOUDINI_ENGINE_MINOR, HAPI_VERSION_HOUDINI_ENGINE_API,
RunningEngineMajor, RunningEngineMinor, RunningEngineApi);
HOUDINI_LOG_WARNING(
TEXT("This could cause instabilities and crashes when using the Houdini Engine plugin"));
}
const UHoudiniRuntimeSettings * HoudiniRuntimeSettings = GetDefault< UHoudiniRuntimeSettings >();
// Default CookOptions
HAPI_CookOptions CookOptions = FHoudiniEngine::GetDefaultCookOptions();
bool bUseCookingThread = true;
HAPI_Result Result = FHoudiniApi::Initialize(
&Session,
&CookOptions,
bUseCookingThread,
HoudiniRuntimeSettings->CookingThreadStackSize,
TCHAR_TO_UTF8(*HoudiniRuntimeSettings->HoudiniEnvironmentFiles),
TCHAR_TO_UTF8(*HoudiniRuntimeSettings->OtlSearchPath),
TCHAR_TO_UTF8(*HoudiniRuntimeSettings->DsoSearchPath),
TCHAR_TO_UTF8(*HoudiniRuntimeSettings->ImageDsoSearchPath),
TCHAR_TO_UTF8(*HoudiniRuntimeSettings->AudioDsoSearchPath));
if (Result == HAPI_RESULT_SUCCESS)
{
HOUDINI_LOG_MESSAGE(TEXT("Successfully intialized the Houdini Engine module."));
}
else if (Result == HAPI_RESULT_ALREADY_INITIALIZED)
{
// Reused session? just notify the user
HOUDINI_LOG_MESSAGE(TEXT("Successfully intialized the Houdini Engine module - HAPI was already initialzed."));
}
else
{
HOUDINI_LOG_ERROR(
TEXT("Houdini Engine API initialization failed: %s"),
*FHoudiniEngineUtils::GetErrorDescription(Result));
return false;
}
// Let HAPI know we are running inside UE4
FHoudiniApi::SetServerEnvString(&Session, HAPI_ENV_CLIENT_NAME, HAPI_UNREAL_CLIENT_NAME);
if (bEnableSessionSync)
{
// Set the session sync infos if needed
UploadSessionSyncInfoToHoudini();
// Indicate that Session Sync is enabled
FString Notification = TEXT("Houdini Engine Session Sync enabled.");
FHoudiniEngineUtils::CreateSlateNotification(Notification);
HOUDINI_LOG_MESSAGE(TEXT("Houdini Engine Session Sync enabled."));
}
return true;
}
void
FHoudiniEngine::OnSessionLost()
{
// Mark the session as invalid
Session.id = -1;
Session.type = HAPI_SESSION_MAX;
SetSessionStatus(EHoudiniSessionStatus::Lost);
bEnableSessionSync = false;
HoudiniEngineManager->StopHoudiniTicking();
// This indicates that we likely have lost the session due to a crash in HARS/Houdini
FString Notification = TEXT("Houdini Engine Session lost!");
FHoudiniEngineUtils::CreateSlateNotification(Notification, 2.0, 4.0);
HOUDINI_LOG_ERROR(TEXT("Houdini Engine Session lost! This could be caused by a crash in HARS."));
}
bool
FHoudiniEngine::StopSession()
{
HAPI_Session* SessionPtr = &Session;
return StopSession(SessionPtr);
}
bool
FHoudiniEngine::StopSession(HAPI_Session*& SessionPtr)
{
// HAPI needs to be initialized
if (!FHoudiniApi::IsHAPIInitialized())
return false;
if (HAPI_RESULT_SUCCESS == FHoudiniApi::IsSessionValid(SessionPtr))
{
// SessionPtr is valid, clean up and close the session
FHoudiniApi::Cleanup(SessionPtr);
FHoudiniApi::CloseSession(SessionPtr);
}
Session.id = -1;
Session.type = HAPI_SESSION_MAX;
SetSessionStatus(EHoudiniSessionStatus::Stopped);
bEnableSessionSync = false;
HoudiniEngineManager->StopHoudiniTicking();
return true;
}
bool
FHoudiniEngine::RestartSession()
{
HAPI_Session* SessionPtr = &Session;
FString StatusText = TEXT("Starting the Houdini Engine session...");
FHoudiniEngine::Get().CreateTaskSlateNotification(FText::FromString(StatusText), true, 4.0f);
// Make sure we stop the current session if it is still valid
bool bSuccess = false;
if (!StopSession(SessionPtr))
{
// StopSession returns false only if Houdini is not initialized
HOUDINI_LOG_ERROR(TEXT("Failed to restart the Houdini Engine session - HAPI Not initialized"));
}
else
{
// Try to reconnect/start a new session
const UHoudiniRuntimeSettings * HoudiniRuntimeSettings = GetDefault< UHoudiniRuntimeSettings >();
if (!StartSession(
SessionPtr,
HoudiniRuntimeSettings->bStartAutomaticServer,
HoudiniRuntimeSettings->AutomaticServerTimeout,
HoudiniRuntimeSettings->SessionType,
HoudiniRuntimeSettings->ServerPipeName,
HoudiniRuntimeSettings->ServerPort,
HoudiniRuntimeSettings->ServerHost))
{
HOUDINI_LOG_ERROR(TEXT("Failed to restart the Houdini Engine session - Failed to start the new Session"));
SetSessionStatus(EHoudiniSessionStatus::Failed);
}
else
{
// Now initialize HAPI with this session
if (!InitializeHAPISession())
{
HOUDINI_LOG_ERROR(TEXT("Failed to restart the Houdini Engine session - Failed to initialize HAPI"));
SetSessionStatus(EHoudiniSessionStatus::Failed);
}
else
{
bSuccess = true;
SetSessionStatus(EHoudiniSessionStatus::Connected);
}
}
}
// Start ticking only if we successfully started the session
if (bSuccess)
{
StartTicking();
return true;
}
else
{
StopTicking();
return false;
}
}
bool
FHoudiniEngine::CreateSession(const EHoudiniRuntimeSettingsSessionType& SessionType, FName OverrideServerPipeName)
{
HAPI_Session* SessionPtr = &Session;
FString StatusText = TEXT("Create the Houdini Engine session...");
FHoudiniEngine::Get().CreateTaskSlateNotification(FText::FromString(StatusText), true, 4.0f);
// Make sure we stop the current session if it is still valid
bool bSuccess = false;
// Try to reconnect/start a new session
const UHoudiniRuntimeSettings * HoudiniRuntimeSettings = GetDefault< UHoudiniRuntimeSettings >();
if (!StartSession(
SessionPtr,
true,
HoudiniRuntimeSettings->AutomaticServerTimeout,
SessionType,
OverrideServerPipeName == NAME_None ? HoudiniRuntimeSettings->ServerPipeName : OverrideServerPipeName.ToString(),
HoudiniRuntimeSettings->ServerPort,
HoudiniRuntimeSettings->ServerHost))
{
HOUDINI_LOG_ERROR(TEXT("Failed to start the Houdini Engine Session"));
SetSessionStatus(EHoudiniSessionStatus::Failed);
}
else
{
// Now initialize HAPI with this session
if (!InitializeHAPISession())
{
HOUDINI_LOG_ERROR(TEXT("Failed to start the Houdini Engine session - Failed to initialize HAPI"));
SetSessionStatus(EHoudiniSessionStatus::Failed);
}
else
{
bSuccess = true;
SetSessionStatus(EHoudiniSessionStatus::Connected);
}
}
// Start ticking only if we successfully started the session
if (bSuccess)