FormIt C++ API  v23.0.0 (2023.0.0)
Public Types | Public Member Functions | List of all members
FormIt::MessageStruct Struct Referenceabstract
FormIt Core API Reference List

Description

The base class for all messages.

#include <FormItMessaging.h>

Inheritance diagram for FormIt::MessageStruct:
FormIt::MessageVoidStruct FormIt::MessageWithPayloadStruct FormIt::kAppUIExitType FormIt::kAppUIInitializedType FormIt::kArrayToolRequestType FormIt::kAutoSaveRequestedType FormIt::kCameraChangedType FormIt::kCameraOperationEndedType FormIt::kCameraOperationStartedType FormIt::kCameraProjectionTypeChangedType FormIt::kContentLibraryLocationsChangedType FormIt::kDefaultColorsChangedType FormIt::kDismissProgressUIType FormIt::kDisplayModeChangedType FormIt::kDynamoFileLocationsChangedType FormIt::kDynamoResetReachType FormIt::kDynamoRunStateChangedType FormIt::kGridScaleChangedType FormIt::kInvalidateEdgesType FormIt::kLCSChangedType FormIt::kLevelManagerChangedType FormIt::kNewModelRequestedType FormIt::kObjectFacetingAccuracyChangedType FormIt::kOxygenAuthenticationStatusChangedType FormIt::kProjectPropertiesChangedType FormIt::kRefresh3DViewType FormIt::kReset3DViewportType FormIt::kRevitFamilyInfoChangedType FormIt::kSampleMaterialsLocationsChangedType FormIt::kSaveLocallyRequestedType FormIt::kSaveLocallyWithHistoryRequestedType FormIt::kSaveRequestedType FormIt::kSceneModifiedStateChangedType FormIt::kScenesAnimationStartStopType FormIt::kScenesRecordEndType FormIt::kScenesUpdatedType FormIt::kSelectionFilterChangedType FormIt::kSelectionsChangedType FormIt::kSolarAnalysisWeatherDataNotAvailableType FormIt::kSunDirectionChangedType FormIt::kSunDirectionChangesEndedType FormIt::kToolModeChangedType FormIt::kToolsLocationRequestType FormIt::kUndoRedoMultipleHistoriesEndedType FormIt::kUnfollowCameraType FormIt::kUnitTypeChangedType FormIt::kVisualStyleChangedType FormIt::kAnalyticsLogType FormIt::kAnimationAddedType FormIt::kAnimationNameUpdatedType FormIt::kAxesVisibilityChangedType FormIt::kCameraSharingChangeType FormIt::kChatEmitType FormIt::kChatReceivedType FormIt::kCollabConnectionChangeType FormIt::kCollaborationInitProgressUpdatedType FormIt::kCollaborationLoadProgressUpdatedType FormIt::kCollaborationTextType FormIt::kCollaborationUserListUpdatedType FormIt::kCollabSessionInitType FormIt::kCreatePanelType FormIt::kCreateToolbarType FormIt::kFollowCameraType FormIt::kFormItJSONMsgType FormIt::kHistoryDeletedForModelTreeOnlyType FormIt::kImageAddedType FormIt::kImageAlphaChangedType FormIt::kImageChangedType FormIt::kImageDeletedType FormIt::kImageOrderChangedType FormIt::kInContextEditingType FormIt::kInferenceEventInferenceLockedChangedType FormIt::kInstallPluginType FormIt::kInvalidatePreviewImageType FormIt::kLayerLoadInRevitChangedType FormIt::kLayerManagerChangedType FormIt::kLayerNameChangedType FormIt::kLayerPickableChangedType FormIt::kLayerVisibilityChangedType FormIt::kLevelsVisibilityChangedType FormIt::kLoadCompleteType FormIt::kLockAndHidePointerType FormIt::kMaterialAddedType FormIt::kMaterialChangedType FormIt::kMaterialCreatedFromSampleType FormIt::kMaterialDataChangedType FormIt::kMaterialDeletedType FormIt::kMaterialManagerChangedType FormIt::kMaterialPickedType FormIt::kModelChangedType FormIt::kObjectsPreselectType FormIt::kOpenFileCompleteType FormIt::kOpenFileStartedType FormIt::kPanoramInProgressType FormIt::kPostProgressUpdateType FormIt::kPresentProgressUIType FormIt::kProjectNameUpdatedType FormIt::kReSize3DViewType FormIt::kRevitConnectionChangeType FormIt::kSampleMaterialsNodeLoadedType FormIt::kSampleMaterialsNodeLoadFailedType FormIt::kSampleMaterialsNodeLoadingStatusChangedType FormIt::kSatelliteImageIsHiddenType FormIt::kSatelliteImageIsVisibleType FormIt::kSaveCompletedType FormIt::kSceneActivatedType FormIt::kSceneAddedType FormIt::kSceneCameraChangedType FormIt::kSceneItemChangedType FormIt::kSceneNameUpdatedType FormIt::kSceneRemovedType FormIt::kScenesRecordFrameType FormIt::kScenesRecordStartType FormIt::kSceneUpdatedType FormIt::kSelectionHightlightEnabledChangedType FormIt::kSendToRevitPreviewChangedType FormIt::kSetCursorType FormIt::kSetLocationType FormIt::kSetToolTypeCursorType FormIt::kShowDimensionEditorType FormIt::kShowDimensionSettingChangedType FormIt::kShowEditedGroupOnlyChangedType FormIt::kShowTooltipType FormIt::kSolarAnalysisFinishedRunType FormIt::kSolarAnalysisModeChangedType FormIt::kSolarAnalysisPeakMonthChangedType FormIt::kSolarAnalysisResultTypeChangedType FormIt::kSolarAnalysisSelectionHighlightType FormIt::kStartUIToolType FormIt::kTestRunningType FormIt::kTimerTickedType FormIt::kToolGotFocusType FormIt::kToolHandledType FormIt::kToolRemovedType FormIt::kTouchEnabledChangedType FormIt::kUndoManagerDeleteAllRedoType FormIt::kUndoManagerStateAddedType FormIt::kUndoManagerStateNameChangeType FormIt::kUndoManagerUpdateType FormIt::kUndoRedoAvailabilityChangedType FormIt::kUndoRedoExecutedType FormIt::kUndoRedoPerHistoryType FormIt::kUninstallPluginType FormIt::kUpdateRenderHistoryType FormIt::kUserEntitlementsChangedType

Public Types

using Payload = void
 

Public Member Functions

virtual ::string message () const =0
 message() function. More...
 
bool operator== (MessageStruct const &right) const
 So we can see if a particular message received is the same as one of the predefined ones using simple comparisons. More...
 
bool operator!= (MessageStruct const &right) const
 

Member Typedef Documentation

using FormIt::MessageStruct::Payload = void

Member Function Documentation

virtual ::string FormIt::MessageStruct::message ( ) const
pure virtual

message() function.

Implemented in FormIt::kFormItJSONMsgType, FormIt::kPanoramInProgressType, FormIt::kSendToRevitPreviewChangedType, FormIt::kUndoRedoMultipleHistoriesEndedType, FormIt::kAnalyticsLogType, FormIt::kSetToolTypeCursorType, FormIt::kSetCursorType, FormIt::kSelectionFilterChangedType, FormIt::kSampleMaterialsLocationsChangedType, FormIt::kSampleMaterialsNodeLoadingStatusChangedType, FormIt::kSampleMaterialsNodeLoadFailedType, FormIt::kSampleMaterialsNodeLoadedType, FormIt::kMaterialCreatedFromSampleType, FormIt::kSelectionHightlightEnabledChangedType, FormIt::kSceneModifiedStateChangedType, FormIt::kDynamoRunStateChangedType, FormIt::kAutoSaveRequestedType, FormIt::kMaterialPickedType, FormIt::kUninstallPluginType, FormIt::kCreatePanelType, FormIt::kInstallPluginType, FormIt::kCreateToolbarType, FormIt::kToolsLocationRequestType, FormIt::kStartUIToolType, FormIt::kShowEditedGroupOnlyChangedType, FormIt::kShowDimensionSettingChangedType, FormIt::kSetLocationType, FormIt::kInferenceEventInferenceLockedChangedType, FormIt::kAppUIExitType, FormIt::kAppUIInitializedType, FormIt::kDynamoFileLocationsChangedType, FormIt::kContentLibraryLocationsChangedType, FormIt::kPostProgressUpdateType, FormIt::kDismissProgressUIType, FormIt::kPresentProgressUIType, FormIt::kUserEntitlementsChangedType, FormIt::kObjectFacetingAccuracyChangedType, FormIt::kUnitTypeChangedType, FormIt::kUnfollowCameraType, FormIt::kUndoRedoPerHistoryType, FormIt::kUndoRedoExecutedType, FormIt::kUndoRedoAvailabilityChangedType, FormIt::kUndoManagerUpdateType, FormIt::kUndoManagerStateNameChangeType, FormIt::kUndoManagerStateAddedType, FormIt::kUndoManagerDeleteAllRedoType, FormIt::kTouchEnabledChangedType, FormIt::kToolModeChangedType, FormIt::kToolRemovedType, FormIt::kToolHandledType, FormIt::kToolGotFocusType, FormIt::kTimerTickedType, FormIt::kTestRunningType, FormIt::kSunDirectionChangesEndedType, FormIt::kSunDirectionChangedType, FormIt::kSolarAnalysisWeatherDataNotAvailableType, FormIt::kSolarAnalysisSelectionHighlightType, FormIt::kSolarAnalysisResultTypeChangedType, FormIt::kSolarAnalysisPeakMonthChangedType, FormIt::kSolarAnalysisModeChangedType, FormIt::kSolarAnalysisFinishedRunType, FormIt::kShowTooltipType, FormIt::kShowDimensionEditorType, FormIt::kUpdateRenderHistoryType, FormIt::kDynamoResetReachType, FormIt::kSelectionsChangedType, FormIt::kScenesAnimationStartStopType, FormIt::kScenesRecordEndType, FormIt::kScenesRecordFrameType, FormIt::kScenesRecordStartType, FormIt::kSceneCameraChangedType, FormIt::kSceneUpdatedType, FormIt::kAnimationNameUpdatedType, FormIt::kSceneNameUpdatedType, FormIt::kScenesUpdatedType, FormIt::kSceneRemovedType, FormIt::kAnimationAddedType, FormIt::kSceneAddedType, FormIt::kSceneActivatedType, FormIt::kSceneItemChangedType, FormIt::kSaveLocallyWithHistoryRequestedType, FormIt::kSaveLocallyRequestedType, FormIt::kSaveCompletedType, FormIt::kSaveRequestedType, FormIt::kSatelliteImageIsHiddenType, FormIt::kSatelliteImageIsVisibleType, FormIt::kReSize3DViewType, FormIt::kReset3DViewportType, FormIt::kRefresh3DViewType, FormIt::kProjectPropertiesChangedType, FormIt::kProjectNameUpdatedType, FormIt::kOxygenAuthenticationStatusChangedType, FormIt::kOpenFileCompleteType, FormIt::kOpenFileStartedType, FormIt::kObjectsPreselectType, FormIt::kNewModelRequestedType, FormIt::kHistoryDeletedForModelTreeOnlyType, FormIt::kModelChangedType, FormIt::kMaterialChangedType, FormIt::kMaterialDeletedType, FormIt::kMaterialAddedType, FormIt::kLockAndHidePointerType, FormIt::kLoadCompleteType, FormIt::kLevelManagerChangedType, FormIt::kLevelsVisibilityChangedType, FormIt::kAxesVisibilityChangedType, FormIt::kLCSChangedType, FormIt::kInvalidatePreviewImageType, FormIt::kMaterialDataChangedType, FormIt::kMaterialManagerChangedType, FormIt::kLayerLoadInRevitChangedType, FormIt::kLayerNameChangedType, FormIt::kLayerManagerChangedType, FormIt::kLayerVisibilityChangedType, FormIt::kLayerPickableChangedType, FormIt::kInvalidateEdgesType, FormIt::kInContextEditingType, FormIt::kImageOrderChangedType, FormIt::kImageDeletedType, FormIt::kImageChangedType, FormIt::kImageAlphaChangedType, FormIt::kImageAddedType, FormIt::kRevitFamilyInfoChangedType, FormIt::kGridScaleChangedType, FormIt::kCameraProjectionTypeChangedType, FormIt::kCameraChangedType, FormIt::kCameraOperationEndedType, FormIt::kCameraOperationStartedType, FormIt::kFollowCameraType, FormIt::kVisualStyleChangedType, FormIt::kDisplayModeChangedType, FormIt::kDefaultColorsChangedType, FormIt::kCollaborationTextType, FormIt::kCollaborationUserListUpdatedType, FormIt::kCollaborationInitProgressUpdatedType, FormIt::kCollaborationLoadProgressUpdatedType, FormIt::kCollabSessionInitType, FormIt::kRevitConnectionChangeType, FormIt::kCollabConnectionChangeType, FormIt::kChatReceivedType, FormIt::kChatEmitType, FormIt::kCameraSharingChangeType, and FormIt::kArrayToolRequestType.

bool FormIt::MessageStruct::operator!= ( MessageStruct const &  right) const
inline
bool FormIt::MessageStruct::operator== ( MessageStruct const &  right) const
inline

So we can see if a particular message received is the same as one of the predefined ones using simple comparisons.

The documentation for this struct was generated from the following file: