C4dUiTools Class Reference

#include <c4duitools.h>

Detailed Description

Internal.

Static Public Member Functions

static MAXON_METHOD OSWindowInterface * GetMainWindow ()
 
static MAXON_METHOD Result< BoolHighlightManager (Int32 managerId, POPUP_CLOSE_MODE closeMode)
 
static MAXON_METHOD void CloseManagerHighlighting ()
 
static MAXON_METHOD Int32 GetManagerIdFromString (const String &str)
 
static MAXON_METHOD Int32 GetCommandIdFromString (const String &commandIdAsString)
 
static MAXON_METHOD Result< void > ShowCommandLocationAndHighlightManagerPopups (Int32 commandId, Int32 managerId, POPUP_CLOSE_MODE closeMode)
 
static MAXON_METHOD void CloseCommandLocationAndHighlightManagerPopups ()
 
static MAXON_METHOD Bool IsR2L ()
 
static MAXON_METHOD OSWindowInterface * GetMostRecentActiveWindow ()
 
static MAXON_METHOD Int32 GetGadgetMinHeight ()
 
static MAXON_METHOD Int32 GetGadgetSpace ()
 
static MAXON_METHOD Tuple< OSWindowDrawHandlerInterface *, IntVector2d32GetUserAreaDrawHandler (cinema::GeUserArea *userArea)
 
static MAXON_METHOD IntVector2d32 GetStoredDialogSize (Int32 pluginId, Int32 subId, const IntVector2d32 &defaultSize)
 
static MAXON_METHOD void GetDialogFrame (cinema::GeDialog *dlg, DrawRectFloat &dlgFrame)
 
static MAXON_METHOD void SetDialogFrame (cinema::GeDialog *dlg, const DrawRectFloat &dlgFrame)
 
static MAXON_METHOD FunctionBaseRef AddPositionChangedObserver (cinema::GeDialog *dlg, Int32 commandId)
 
static MAXON_METHOD Bool RemovePositionChangedObserver (cinema::GeDialog *dlg, const FunctionBaseRef &func)
 
static MAXON_METHOD FunctionBaseRef AddMainWindowPositionChangedObserver (cinema::GeDialog *dlg, Int32 commandId)
 
static MAXON_METHOD Bool RemoveMainWindowPositionChangedObserver (const FunctionBaseRef &func)
 
static MAXON_METHOD Int32 GetFontAdjustedHeight (Int32 height)
 
static MAXON_METHOD void ConstrainFramePositionToMonitor (DrawRectInt &frame, const DrawRectInt &monitorFrame)
 
static MAXON_METHOD void GetMonitorFrameFromDialog (cinema::GeDialog *dlg, DrawRectInt &monitorFrame)
 
static MAXON_METHOD Float GetGadgetCornerRadius ()
 
static MAXON_METHOD Tuple< String, StringExtractAndRemoveDelimitedSubstring (const String &text, const String &delimiterPreffix, const String &delimiterSuffix)
 
static MAXON_METHOD Result< void > DrawOverlayedRoundedCorners (cinema::GeUserArea &ua, Int32 x1, Int32 y1, Int32 x2, Int32 y2, const Vector2d &radius, CORNERS corners=CORNERS::ALL)
 
static MAXON_METHOD String GetButtonString (const String &name, const String &bubbleHelp, Int32 iconId=0)
 
static MAXON_METHOD String GetApplicationName ()
 
static MAXON_METHOD void RevealManager (Int32 managerId)
 
static MAXON_METHOD Result< void > ShowOverlayMessage (const String &title, const String &message)
 
static MAXON_METHOD Result< void > CloseOverlayMessage ()
 
static MAXON_METHOD Result< void > SetOverlayProgress (Float percent, const String &detailText)
 
static MAXON_METHOD Result< void > ShowWelcomeScreen ()
 
static MAXON_METHOD Result< void > CloseWelcomeScreen ()
 

Private Member Functions

 MAXON_INTERFACE_NONVIRTUAL (C4dUiTools, MAXON_REFERENCE_STATIC, "net.maxon.interface.c4duitools")
 

Member Function Documentation

◆ MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( C4dUiTools  ,
MAXON_REFERENCE_STATIC  ,
"net.maxon.interface.c4duitools"   
)
private

◆ GetMainWindow()

static MAXON_METHOD OSWindowInterface* GetMainWindow ( )
static

Internal.

◆ HighlightManager()

static MAXON_METHOD Result<Bool> HighlightManager ( Int32  managerId,
POPUP_CLOSE_MODE  closeMode 
)
static

Internal.

◆ CloseManagerHighlighting()

static MAXON_METHOD void CloseManagerHighlighting ( )
static

Internal.

◆ GetManagerIdFromString()

static MAXON_METHOD Int32 GetManagerIdFromString ( const String str)
static

Internal.

◆ GetCommandIdFromString()

static MAXON_METHOD Int32 GetCommandIdFromString ( const String commandIdAsString)
static

Internal.

◆ ShowCommandLocationAndHighlightManagerPopups()

static MAXON_METHOD Result<void> ShowCommandLocationAndHighlightManagerPopups ( Int32  commandId,
Int32  managerId,
POPUP_CLOSE_MODE  closeMode 
)
static

Internal.

◆ CloseCommandLocationAndHighlightManagerPopups()

static MAXON_METHOD void CloseCommandLocationAndHighlightManagerPopups ( )
static

Internal.

◆ IsR2L()

static MAXON_METHOD Bool IsR2L ( )
static

Internal.

◆ GetMostRecentActiveWindow()

static MAXON_METHOD OSWindowInterface* GetMostRecentActiveWindow ( )
static

Returns the most recent active window. Can be used in OSGuiRef::ChooseUrls as parent window to return to. Internal.

◆ GetGadgetMinHeight()

static MAXON_METHOD Int32 GetGadgetMinHeight ( )
static

Internal.

◆ GetGadgetSpace()

static MAXON_METHOD Int32 GetGadgetSpace ( )
static

Internal.

◆ GetUserAreaDrawHandler()

static MAXON_METHOD Tuple<OSWindowDrawHandlerInterface*, IntVector2d32> GetUserAreaDrawHandler ( cinema::GeUserArea userArea)
static

Internal.

◆ GetStoredDialogSize()

static MAXON_METHOD IntVector2d32 GetStoredDialogSize ( Int32  pluginId,
Int32  subId,
const IntVector2d32 defaultSize 
)
static

Internal.

◆ GetDialogFrame()

static MAXON_METHOD void GetDialogFrame ( cinema::GeDialog dlg,
DrawRectFloat dlgFrame 
)
static

Internal.

◆ SetDialogFrame()

static MAXON_METHOD void SetDialogFrame ( cinema::GeDialog dlg,
const DrawRectFloat dlgFrame 
)
static

Internal.

◆ AddPositionChangedObserver()

static MAXON_METHOD FunctionBaseRef AddPositionChangedObserver ( cinema::GeDialog dlg,
Int32  commandId 
)
static

Internal.

◆ RemovePositionChangedObserver()

static MAXON_METHOD Bool RemovePositionChangedObserver ( cinema::GeDialog dlg,
const FunctionBaseRef &  func 
)
static

Internal.

◆ AddMainWindowPositionChangedObserver()

static MAXON_METHOD FunctionBaseRef AddMainWindowPositionChangedObserver ( cinema::GeDialog dlg,
Int32  commandId 
)
static

Internal.

◆ RemoveMainWindowPositionChangedObserver()

static MAXON_METHOD Bool RemoveMainWindowPositionChangedObserver ( const FunctionBaseRef &  func)
static

Internal.

◆ GetFontAdjustedHeight()

static MAXON_METHOD Int32 GetFontAdjustedHeight ( Int32  height)
static

Internal.

◆ ConstrainFramePositionToMonitor()

static MAXON_METHOD void ConstrainFramePositionToMonitor ( DrawRectInt frame,
const DrawRectInt monitorFrame 
)
static

Internal.

◆ GetMonitorFrameFromDialog()

static MAXON_METHOD void GetMonitorFrameFromDialog ( cinema::GeDialog dlg,
DrawRectInt monitorFrame 
)
static

Internal.

◆ GetGadgetCornerRadius()

static MAXON_METHOD Float GetGadgetCornerRadius ( )
static

Internal.

◆ ExtractAndRemoveDelimitedSubstring()

static MAXON_METHOD Tuple<String, String> ExtractAndRemoveDelimitedSubstring ( const String text,
const String delimiterPreffix,
const String delimiterSuffix 
)
static

Extracts from the input text, the string delimited with a preffix and a suffix, and the input string cleaned. Example: using as input text: "My Tab Title&i12345&", delimiterPreffix: "&i", delimiterSuffix "&", will result in extractedString: "12345", cleanedString: "My Tab Title" Internal.

◆ DrawOverlayedRoundedCorners()

static MAXON_METHOD Result<void> DrawOverlayedRoundedCorners ( cinema::GeUserArea ua,
Int32  x1,
Int32  y1,
Int32  x2,
Int32  y2,
const Vector2d radius,
CORNERS  corners = CORNERS::ALL 
)
static

Internal.

◆ GetButtonString()

static MAXON_METHOD String GetButtonString ( const String name,
const String bubbleHelp,
Int32  iconId = 0 
)
static

Internal.

◆ GetApplicationName()

static MAXON_METHOD String GetApplicationName ( )
static

Internal.

◆ RevealManager()

static MAXON_METHOD void RevealManager ( Int32  managerId)
static

Internal.

◆ ShowOverlayMessage()

static MAXON_METHOD Result<void> ShowOverlayMessage ( const String title,
const String message 
)
static

Internal.

◆ CloseOverlayMessage()

static MAXON_METHOD Result<void> CloseOverlayMessage ( )
static

Internal.

◆ SetOverlayProgress()

static MAXON_METHOD Result<void> SetOverlayProgress ( Float  percent,
const String detailText 
)
static

Internal.

◆ ShowWelcomeScreen()

static MAXON_METHOD Result<void> ShowWelcomeScreen ( )
static

Internal.

◆ CloseWelcomeScreen()

static MAXON_METHOD Result<void> CloseWelcomeScreen ( )
static

Internal.