FormIt C++ API v25.0.0 (2025.0.0)
Loading...
Searching...
No Matches
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::kCopyType FormIt::kCutType FormIt::kDefaultColorsChangedType FormIt::kDismissProgressUIType FormIt::kDisplayModeChangedType FormIt::kDynamoFileLocationsChangedType FormIt::kDynamoResetReachType FormIt::kDynamoRunStateChangedType FormIt::kGridScaleChangedType FormIt::kInferenceEventIgnoreObjectChangedType FormIt::kInvalidateEdgesType FormIt::kLCSChangedType FormIt::kLevelManagerChangedType FormIt::kNewModelRequestedType FormIt::kObjectFacetingAccuracyChangedType FormIt::kOxygenAuthenticationStatusChangedType FormIt::kPasteInPlaceType FormIt::kPasteType 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::kToggleAllPalettesVisibilityRequestedType FormIt::kToolFeatureFlagChangedType FormIt::kToolModeChangedType FormIt::kToolsLocationRequestType FormIt::kUnfollowCameraType FormIt::kUnitTypeChangedType FormIt::kVisualStyleChangedType FormIt::kAnalyticsLogType FormIt::kAnimationAddedType FormIt::kAnimationNameUpdatedType FormIt::kAxesVisibilityChangedType FormIt::kCameraSharingChangeType FormIt::kChatEmitType FormIt::kChatReceivedType FormIt::kCollabConnectionChangeType FormIt::kCollabSessionInitType FormIt::kCollaborationInitProgressUpdatedType FormIt::kCollaborationLoadProgressUpdatedType FormIt::kCollaborationTextType FormIt::kCollaborationUserListUpdatedType FormIt::kCreatePanelType FormIt::kCreateToolbarType FormIt::kDimensionGraphicsUpdateType FormIt::kFYSpriteCreateType FormIt::kFYSpriteDeleteType FormIt::kFYSpriteSetPositionType FormIt::kFYSpriteSetTransformType FormIt::kFYSpriteSetVisibleType FormIt::kFollowCameraType FormIt::kFormItJSONMsgType FormIt::kGraphicsFactoryCreateMarkerType FormIt::kGraphicsFactoryDeleteItemType FormIt::kGraphicsFactoryMarkerSetActiveType FormIt::kGraphicsFactoryMarkerSetPositionType FormIt::kGraphicsFactoryMarkerSetVisibleType FormIt::kGraphicsFactoryPolygonCreateType FormIt::kGraphicsFactoryPolygonDeleteType FormIt::kGraphicsFactoryPolygonSetMaterialNameType FormIt::kGraphicsFactoryPolygonSetMaterialPropsType FormIt::kGraphicsFactoryPolygonSetPositionsType FormIt::kGraphicsFactoryPolygonSetTransformType FormIt::kGraphicsFactoryPolygonSetVisibleType FormIt::kGraphicsFactoryPolylineCreateType FormIt::kGraphicsFactoryPolylineDeleteType FormIt::kGraphicsFactoryPolylineSetPositionsType FormIt::kGraphicsFactoryPolylineSetTransformType FormIt::kGraphicsFactoryPolylineSetVisibleType FormIt::kHUDMessageType 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::kPlacementToolTransformType FormIt::kPostProgressUpdateType FormIt::kPresentProgressUIType FormIt::kPrimitiveCreationToolFinishType FormIt::kPrimitiveCreationToolInitType FormIt::kProjectNameUpdatedType FormIt::kReSize3DViewType FormIt::kRevitConnectionChangeType FormIt::kSampleMaterialsNodeLoadFailedType FormIt::kSampleMaterialsNodeLoadedType FormIt::kSampleMaterialsNodeLoadingStatusChangedType FormIt::kSatelliteImageIsHiddenType FormIt::kSatelliteImageIsVisibleType FormIt::kSaveCompletedType FormIt::kSceneActivatedType FormIt::kSceneAddedType FormIt::kSceneCameraChangedType FormIt::kSceneItemChangedType FormIt::kSceneNameUpdatedType FormIt::kSceneRemovedType FormIt::kSceneUpdatedType FormIt::kScenesRecordFrameType FormIt::kScenesRecordStartType 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::kTempRendererCreateType FormIt::kTempRendererDestroyType FormIt::kTempRendererUpdateType FormIt::kTestRunningType FormIt::kTimerTickedType FormIt::kToolDimensionDeleteType FormIt::kToolDimensionInitType FormIt::kToolDimensionSetEnabledType FormIt::kToolDimensionSetPointsType FormIt::kToolDimensionUpdateAngularType FormIt::kToolDimensionUpdateLinearType FormIt::kToolDimensionUpdateScalarType 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.
 
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.
 
bool operator!= (MessageStruct const &right) const
 

Member Typedef Documentation

◆ Payload

using FormIt::MessageStruct::Payload = void

Member Function Documentation

◆ message()

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

message() function.

Implemented in FormIt::kArrayToolRequestType, FormIt::kCameraSharingChangeType, FormIt::kChatEmitType, FormIt::kChatReceivedType, FormIt::kCollabConnectionChangeType, FormIt::kRevitConnectionChangeType, FormIt::kCollabSessionInitType, FormIt::kCollaborationLoadProgressUpdatedType, FormIt::kCollaborationInitProgressUpdatedType, FormIt::kCollaborationUserListUpdatedType, FormIt::kCollaborationTextType, FormIt::kDefaultColorsChangedType, FormIt::kDisplayModeChangedType, FormIt::kVisualStyleChangedType, FormIt::kFollowCameraType, FormIt::kCameraOperationStartedType, FormIt::kCameraOperationEndedType, FormIt::kCameraChangedType, FormIt::kCameraProjectionTypeChangedType, FormIt::kGridScaleChangedType, FormIt::kRevitFamilyInfoChangedType, FormIt::kImageAddedType, FormIt::kImageAlphaChangedType, FormIt::kImageChangedType, FormIt::kImageDeletedType, FormIt::kImageOrderChangedType, FormIt::kInContextEditingType, FormIt::kInvalidateEdgesType, FormIt::kLayerPickableChangedType, FormIt::kLayerVisibilityChangedType, FormIt::kLayerManagerChangedType, FormIt::kLayerNameChangedType, FormIt::kLayerLoadInRevitChangedType, FormIt::kMaterialManagerChangedType, FormIt::kMaterialDataChangedType, FormIt::kInvalidatePreviewImageType, FormIt::kLCSChangedType, FormIt::kAxesVisibilityChangedType, FormIt::kLevelsVisibilityChangedType, FormIt::kLevelManagerChangedType, FormIt::kLoadCompleteType, FormIt::kLockAndHidePointerType, FormIt::kMaterialAddedType, FormIt::kMaterialDeletedType, FormIt::kMaterialChangedType, FormIt::kModelChangedType, FormIt::kHistoryDeletedForModelTreeOnlyType, FormIt::kNewModelRequestedType, FormIt::kObjectsPreselectType, FormIt::kOpenFileStartedType, FormIt::kOpenFileCompleteType, FormIt::kOxygenAuthenticationStatusChangedType, FormIt::kProjectNameUpdatedType, FormIt::kProjectPropertiesChangedType, FormIt::kRefresh3DViewType, FormIt::kReset3DViewportType, FormIt::kReSize3DViewType, FormIt::kSatelliteImageIsVisibleType, FormIt::kSatelliteImageIsHiddenType, FormIt::kSaveRequestedType, FormIt::kSaveCompletedType, FormIt::kSaveLocallyRequestedType, FormIt::kSaveLocallyWithHistoryRequestedType, FormIt::kSceneItemChangedType, FormIt::kSceneActivatedType, FormIt::kSceneAddedType, FormIt::kAnimationAddedType, FormIt::kSceneRemovedType, FormIt::kScenesUpdatedType, FormIt::kSceneNameUpdatedType, FormIt::kAnimationNameUpdatedType, FormIt::kSceneUpdatedType, FormIt::kSceneCameraChangedType, FormIt::kScenesRecordStartType, FormIt::kScenesRecordFrameType, FormIt::kScenesRecordEndType, FormIt::kScenesAnimationStartStopType, FormIt::kSelectionsChangedType, FormIt::kDynamoResetReachType, FormIt::kUpdateRenderHistoryType, FormIt::kShowDimensionEditorType, FormIt::kShowTooltipType, FormIt::kSolarAnalysisFinishedRunType, FormIt::kSolarAnalysisModeChangedType, FormIt::kSolarAnalysisPeakMonthChangedType, FormIt::kSolarAnalysisResultTypeChangedType, FormIt::kSolarAnalysisSelectionHighlightType, FormIt::kSolarAnalysisWeatherDataNotAvailableType, FormIt::kSunDirectionChangedType, FormIt::kSunDirectionChangesEndedType, FormIt::kTestRunningType, FormIt::kTimerTickedType, FormIt::kToolGotFocusType, FormIt::kToolHandledType, FormIt::kToolRemovedType, FormIt::kToolModeChangedType, FormIt::kTouchEnabledChangedType, FormIt::kUndoManagerDeleteAllRedoType, FormIt::kUndoManagerStateAddedType, FormIt::kUndoManagerStateNameChangeType, FormIt::kUndoManagerUpdateType, FormIt::kUndoRedoAvailabilityChangedType, FormIt::kUndoRedoExecutedType, FormIt::kUndoRedoPerHistoryType, FormIt::kUnfollowCameraType, FormIt::kUnitTypeChangedType, FormIt::kObjectFacetingAccuracyChangedType, FormIt::kUserEntitlementsChangedType, FormIt::kPresentProgressUIType, FormIt::kDismissProgressUIType, FormIt::kPostProgressUpdateType, FormIt::kContentLibraryLocationsChangedType, FormIt::kDynamoFileLocationsChangedType, FormIt::kAppUIInitializedType, FormIt::kAppUIExitType, FormIt::kInferenceEventInferenceLockedChangedType, FormIt::kInferenceEventIgnoreObjectChangedType, FormIt::kSetLocationType, FormIt::kShowDimensionSettingChangedType, FormIt::kShowEditedGroupOnlyChangedType, FormIt::kToggleAllPalettesVisibilityRequestedType, FormIt::kStartUIToolType, FormIt::kToolsLocationRequestType, FormIt::kCreateToolbarType, FormIt::kInstallPluginType, FormIt::kCreatePanelType, FormIt::kUninstallPluginType, FormIt::kMaterialPickedType, FormIt::kAutoSaveRequestedType, FormIt::kDynamoRunStateChangedType, FormIt::kSceneModifiedStateChangedType, FormIt::kSelectionHightlightEnabledChangedType, FormIt::kMaterialCreatedFromSampleType, FormIt::kSampleMaterialsNodeLoadedType, FormIt::kSampleMaterialsNodeLoadFailedType, FormIt::kSampleMaterialsNodeLoadingStatusChangedType, FormIt::kSampleMaterialsLocationsChangedType, FormIt::kSelectionFilterChangedType, FormIt::kSetCursorType, FormIt::kSetToolTypeCursorType, FormIt::kAnalyticsLogType, FormIt::kSendToRevitPreviewChangedType, FormIt::kPanoramInProgressType, FormIt::kFormItJSONMsgType, FormIt::kCutType, FormIt::kCopyType, FormIt::kPasteType, FormIt::kPasteInPlaceType, FormIt::kToolFeatureFlagChangedType, FormIt::kGraphicsFactoryCreateMarkerType, FormIt::kGraphicsFactoryDeleteItemType, FormIt::kGraphicsFactoryMarkerSetPositionType, FormIt::kGraphicsFactoryMarkerSetVisibleType, FormIt::kGraphicsFactoryMarkerSetActiveType, FormIt::kGraphicsFactoryPolylineCreateType, FormIt::kGraphicsFactoryPolylineSetPositionsType, FormIt::kGraphicsFactoryPolylineSetTransformType, FormIt::kGraphicsFactoryPolylineSetVisibleType, FormIt::kGraphicsFactoryPolylineDeleteType, FormIt::kGraphicsFactoryPolygonCreateType, FormIt::kGraphicsFactoryPolygonSetPositionsType, FormIt::kGraphicsFactoryPolygonSetTransformType, FormIt::kGraphicsFactoryPolygonSetMaterialNameType, FormIt::kGraphicsFactoryPolygonSetMaterialPropsType, FormIt::kGraphicsFactoryPolygonSetVisibleType, FormIt::kGraphicsFactoryPolygonDeleteType, FormIt::kFYSpriteCreateType, FormIt::kFYSpriteSetPositionType, FormIt::kFYSpriteSetTransformType, FormIt::kFYSpriteSetVisibleType, FormIt::kFYSpriteDeleteType, FormIt::kHUDMessageType, FormIt::kTempRendererCreateType, FormIt::kTempRendererDestroyType, FormIt::kTempRendererUpdateType, FormIt::kPrimitiveCreationToolInitType, FormIt::kPlacementToolTransformType, FormIt::kPrimitiveCreationToolFinishType, FormIt::kToolDimensionInitType, FormIt::kToolDimensionDeleteType, FormIt::kToolDimensionUpdateLinearType, FormIt::kToolDimensionUpdateScalarType, FormIt::kToolDimensionUpdateAngularType, FormIt::kToolDimensionSetPointsType, FormIt::kDimensionGraphicsUpdateType, and FormIt::kToolDimensionSetEnabledType.

◆ operator!=()

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

◆ operator==()

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: