Functions
ai_adp.h File Reference

Autodesk Analytics Program. More...

#include "ai_api.h"
#include "ai_map.h"
#include "ai_string.h"

Go to the source code of this file.

Functions

AI_API AI_DEPRECATED bool AiPromptADPDialog ()
 Display dialog box for toggling ADP logging state. More...
 
AI_API bool AiADPIntroWasShown ()
 Before ADP collects any data, we need to let the user know that Arnold data is being sent to adsk. More...
 
AI_API void AiADPSetIntroShown ()
 Call this after displaying the intro to user so we don't keep displaying intro message.
 
AI_API void AiADPSetOptedIn (bool wants_optin)
 Set to true if user agreed to optin and false if opted out.
 
AI_API bool AiADPIsOptedIn ()
 
AI_API void AiADPDialogStrings (AtParamValueMap &strings, const char *custom_optin_command)
 Strings and URLs to display to user when displaying ADP related dialog boxes. More...
 

Detailed Description

Autodesk Analytics Program.

Function Documentation

AI_API AI_DEPRECATED bool AiPromptADPDialog ( )

Display dialog box for toggling ADP logging state.

This does not work in Linux, is deprecated, and will be removed in an upcoming release.

Returns
true if there were no errors
AI_API bool AiADPIntroWasShown ( )

Before ADP collects any data, we need to let the user know that Arnold data is being sent to adsk.

This happens one time and then they never need to be shown this message again.

If this returns true, no need to do anything. If false, then do something like:

1 if (!AiADPIntroWasShown())
2 {
3  AtString title, introduction, learnMoreText, learnMoreURL, privacyText, privacyURL;
4  AiADPDialogStringsIntro(title, introduction, learnMoreText, learnMoreURL,
5  privacyText, privacyURL);
6 
7  // in a GUI dialog present the equivalent:
8  dialog_title(title);
9  dialog_text_body(introduction + " or through the <your plugin> help menu/Autodesk Analytics menu option"); // tune this for your plugin
10  dialog_url1(learnMoreText, learnMoreURL); // should be a clickable link
11  dialog_url2(privacyText, privacyURL); // should be a clickable link
12  gui_dialog_box_with_OK_button();
13 
14  AiADPSetIntroShown();
15 }
Returns
true if the user was previously shown the Autodesk Analytics program data involvement agreement
AI_API bool AiADPIsOptedIn ( )
Returns
true if user agreed to opt in and false if opted out.
AI_API void AiADPDialogStrings ( AtParamValueMap &  strings,
const char *  custom_optin_command 
)

Strings and URLs to display to user when displaying ADP related dialog boxes.

There are two dialog boxes:

INTRO is used when the user has never before been informed about the Autodesk Analytics program. This will include an introduction_intro string with instructions for how to change the opt-in/out settings using kick, since all plugins come with kick. If your plugin has its own way for changing the optin settings, and it probably should, then instructions for how to do so should go in the custom_optin_command argument and the introduction_intro string will then include that as well. For instance: custom_optin_command="in the C4DtoA > Help menu". Otherwise, custom_optin_command can be NULL.

CHANGE is used after the user has been shown the intro dialog and wants to change opt-in status. Note that this mode has an additional "checkbox" string and instead of "introduction_intro" should use the "introduction_change" string.

The other strings are the "title", "learnMoreURL" and associated "learnMoreText" link, and the "privacyURL" and associated "privacyText" link.


© 2020 Autodesk, Inc. · All rights reserved · www.arnoldrenderer.com