Loading data .... Please wait

SDK rules:

   ( based on the SDK Overview.pdf  [page 24] and the Include files )

1. ClassID in combination with FamilyID must be unique.
2. ClassIDs reserved by DAZ:
   • range: "AAAA" thru "AAAZ"
   • ClassIDs with 4 lowercase characters
3. ClassGUID in combination with FamilyGUID must be unique.
4. CommandID (a.k.a. menu actionnumber a.k.a. toolID) must be unique. ( Include/Carrara/External3DAPI.r )
5. 3rd Party CommandID should start at 500000 ( kThirdPartiesCmdIDBase in Include/Carrara/CommandIdRanges.h )
6. Avoid using ASCII code > 128 as ClassID chars. They are different between MacOS and Windows.

Other sensible rules:

7. Keyboard shortcut should be unique.
8. Do not use SDK ClassIDs or CommandIDs in 3rd Party Extensions. They might clash with SDK Samples.

Close
Purpose:
To help Carrara Plug-in developers in determining and finding a new ClassID, CommandID or shortcut that is not already in use. And thus preventing clashing with other plug-ins or even crashing Carrara.
⇒ It can also be used to lookup the precompiler Family strings ( kRID_... and R_IID_... ).

Last database update:   13 Apr 2023 13:52 - UTC

Website:
The website is vertically divided into three sections.

• The upper is the control section.
  The first four buttons (Overall, COMP, GUID and scmd) each select a different separate view on the data. The 'Show Only Issues' button filters out all the plug-ins with an empty 'Rules' field. The 'Switch theme' button toggles between a light and a dark theme. The 'About' button displays this document.
• The middle is the data section.
  It displays the data selected with one of the view-buttons. Use the little up and down triangles next to the column-headers to sort the table. It toggles between ascending and descending. For multiple column sort press and hold the Shift-key. Use the search input field to apply a filter.
• The bottom is a legend section.
  It provides an explanation of the numbers in the 'Rules' column. The rules corresponds with the ones on page 24 of the SDK 'Overview.pdf' and those found in the SDK Include Files.

Database:
A Python programm is used to extract the data from the ".dat" files and to evaluate the compliance with the rules. The database is read-only and only contains data from the Carrara plug-ins that are installed on my computer.

The following table shows the layout.

Column #	Column Name	Description / remark
1	Extension file	Name of the Extension / Plug-in *.dat file.
2	ResourceID	ID of the resource.
from the Component resource ( COMP )
3	Family	Precompiler string obtained from the SDK Include files.
4	FamilyID	4 char ID of the resource family
5	ClassID	4 char ID of the class
6  *)	CombinedIDs	Concatination of FamilyID and ClassID MUST be unique!
from the GUID resource ( GUID )
7	Family_RIID	Precompiler string obtained from the SDK Include files.
8	FamilyGUID	128 bit GUID of the resource family
9	ClassGUID	128 bit GUID of the class
10  *)	CombinedGUIDs	Concatination of FamilyGUID and ClassGUID MUST be unique!
from the SceneCommand resource ( scmd )
11	CommandID	aka menu actionnumber and ToolID MUST be unique!
12	Rooms	Rooms where CommandID will be active '3Dvw'=Assembly; 'Stry'=Storyboard; 'shmn'=Shader
13	GroupID	Top menu of CommandID/menu item Mostly the 'edit' menu.
14	Key	Keyboard key of Shortcut
15	Shift	Use of Shift key 0=noShift; 1=Shift
16	Ctrl/Cmd	Use of Ctrl/Cmd key (win/mac) 0=noCtrl/Cmd; 1=Ctrl/Cmd
17	Alt/Option	Use of Alt/Option key (win/mac) 0=noAlt/Options; 1=Alt/Option
18	Platforms	Active on platform 0=Windows; 1=Mac; -1=any
19  *)	Shortcut	Concatination of Key, Shift, Ctrl/Cmd and Alt/Option
end of resource ( scmd )
20	Rules	Rules broken. See bottom section for an explanation
21	Origin / Developer	Name of originator / developer: 'Carrara Basics' or else name of 3rd Party developer.

*)  To save screen space concatinated columns are not shown in the 'Overall'-view.