FormIt C++ API  v23.0.0 (2023.0.0)
FormIt::MessageWithPayloadStruct Struct Reference

Description

The base class for all structures that have a payload.

It allows the derived class to extract the payload.

#include <FormItMessaging.h>

Inheritance diagram for FormIt::MessageWithPayloadStruct:
FormIt::MessageStruct 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

Protected Member Functions

template<typename T >
const T & cast (MessagePayloadStruct const &payload) const
 

Additional Inherited Members

- Public Types inherited from FormIt::MessageStruct
using Payload = void
 
- Public Member Functions inherited from FormIt::MessageStruct
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 Function Documentation

template<typename T >
const T& FormIt::MessageWithPayloadStruct::cast ( MessagePayloadStruct const &  payload) const
inlineprotected

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