{"id":2521,"date":"2022-09-24T09:35:22","date_gmt":"2022-09-24T09:35:22","guid":{"rendered":"https:\/\/3dcoat.com\/documentation\/?post_type=manual_documentation&p=2521"},"modified":"2023-11-08T11:15:26","modified_gmt":"2023-11-08T11:15:26","slug":"core-api","status":"publish","type":"manual_documentation","link":"https:\/\/3dcoat.com\/documentation\/manual\/scripting-and-core-api\/core-api\/","title":{"rendered":"Core API"},"content":{"rendered":"\n

The Core API<\/strong> is a powerful method to extend 3DCoat’s functionality. You can automate the job or add principally new tools. This is not just the scripting; the code you write runs at the full speed of compiled C++. We use Microsoft Visual Studio<\/strong> for the compiling. But the whole process is entirely transparent for you. You don’t need to configure anything or manage complex project configurations. 3DCoat will lead you through the whole process with a simple wizard.<\/p>\n\n\n\n

Quickstart<\/h1>\n\n\n\n
\n
Core API manual introduction<\/a><\/div>\n<\/div>\n\n\n\n

<\/p>\n\n\n\n

The core API requires Visual Studio 2022 Community<\/strong> with the C++ features installed. If you have not installed Visual Studio, 3DCoat will help to install it with the correct options.
The start is quite easy. Just use Scripts->Create new Core API script<\/strong><\/p>\n\n\n

\n
\"\"\/<\/figure>\n<\/div>\n\n\n

Choose the template and path for your project. Then 3DCoat will assist you in installing the Visual Studio if needed.
Each example is well documented and uses relatively simple syntax, making it easy to understand from basic to complex.
There are several important notes you need to know:
1) Always start your project from one of the examples. Even if you want to make everything from scratch, use Scripts->Create new Core API script->Minimal c++ program<\/strong> as your starting point. Don’t create the project manually!
2) Use Debugging<\/a>; it is very convenient; all 3DCoat native data types are shown in a user-friendly interface.
3) Always follow the Visual Studio linter hints to write the correct code. Hover over the data types and function names to access the documentation on-the-fly.<\/p>\n\n\n

\n
\"\"\/<\/figure>\n<\/div>\n\n\n

4) Don’t read the full documentation. It is impossible to remember. Follow the Examples<\/a> first. And then look at the documentation if you need some details.
5) Look at the C++ syntax, but don’t read the whole manual; take the basics first
6) Click on the item in the Script menu to execute. Use RMB click to get the useful commands – edit<\/strong>, build<\/strong>, rebuild<\/strong>. You may also create a distributive of your script to share with other users.<\/p>\n\n\n

\n
\"\"\/<\/figure>\n<\/div>\n\n\n

Addendum:<\/strong><\/p>\n\n\n\n

    \n
  • You can access to live booleans via the python\/CoreAPI.<\/li>\n\n\n\n
  • Additional self-test mechanism to prevent situations when CoreAPI gets failed into the build. Also, any script may be executed as 3DCoat.exe -script “path to cpp\/python script”.
    The script may do some action and exit using coat::utils::quit() \/ coat.utils.quit()<\/li>\n<\/ul>\n","protected":false},"author":3,"featured_media":0,"parent":2379,"menu_order":2,"template":"","manualdocumentationcategory":[9],"manual_doc_tag":[],"class_list":["post-2521","manual_documentation","type-manual_documentation","status-publish","hentry","manualdocumentationcategory-manual"],"yoast_head":"\nCore API - 3DCoat Documentation<\/title>\n<meta name=\"description\" content=\"Explanation of the basic principles of use in the Core API. And the link to the main section of the Core API documentation\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/3dcoat.com\/documentation\/manual\/scripting-and-core-api\/core-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Core API - 3DCoat Documentation\" \/>\n<meta property=\"og:description\" content=\"Explanation of the basic principles of use in the Core API. And the link to the main section of the Core API documentation\" \/>\n<meta property=\"og:url\" content=\"https:\/\/3dcoat.com\/documentation\/manual\/scripting-and-core-api\/core-api\/\" \/>\n<meta property=\"og:site_name\" content=\"3DCoat Documentation\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/3DCoat\" \/>\n<meta property=\"article:modified_time\" content=\"2023-11-08T11:15:26+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/3dcoat.com\/files\/3dcoat\/CoreAPI\/core_api_start.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@3DCoatOfficial\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/\",\"url\":\"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/\",\"name\":\"Core API - 3DCoat Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/3dcoat.com\/files\/3dcoat\/CoreAPI\/core_api_start.png\",\"datePublished\":\"2022-09-24T09:35:22+00:00\",\"dateModified\":\"2023-11-08T11:15:26+00:00\",\"description\":\"Core API\u4e2d\u7684\u57fa\u672c\u4f7f\u7528\u539f\u7406\u8bf4\u660e\u3002\u4ee5\u53caCore API\u6587\u6863\u4e3b\u8981\u90e8\u5206\u7684\u94fe\u63a5\",\"breadcrumb\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/#primaryimage\",\"url\":\"https:\/\/3dcoat.com\/files\/3dcoat\/CoreAPI\/core_api_start.png\",\"contentUrl\":\"https:\/\/3dcoat.com\/files\/3dcoat\/CoreAPI\/core_api_start.png\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/3dcoat.com\/documentation\/nl_NL\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Scripting & Core API\",\"item\":\"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Core API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/#website\",\"url\":\"https:\/\/3dcoat.com\/documentation\/\",\"name\":\"3DCoat Documentation\",\"description\":\"Information about starting to use and learning how to use all the features of the 3DCoat.\",\"publisher\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/3dcoat.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/#organization\",\"name\":\"Pilgway\",\"url\":\"https:\/\/3dcoat.com\/documentation\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/09\/logo3DCoatWhite-1.png\",\"contentUrl\":\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/09\/logo3DCoatWhite-1.png\",\"width\":876,\"height\":190,\"caption\":\"Pilgway\"},\"image\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/3DCoat\",\"https:\/\/x.com\/3DCoatOfficial\",\"https:\/\/www.youtube.com\/c\/PILGWAY3DCoat\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Core API - 3DCoat Documentation","description":"Explanation of the basic principles of use in the Core API. And the link to the main section of the Core API documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/3dcoat.com\/documentation\/manual\/scripting-and-core-api\/core-api\/","og_locale":"en_US","og_type":"article","og_title":"Core API - 3DCoat Documentation","og_description":"Explanation of the basic principles of use in the Core API. And the link to the main section of the Core API documentation","og_url":"https:\/\/3dcoat.com\/documentation\/manual\/scripting-and-core-api\/core-api\/","og_site_name":"3DCoat Documentation","article_publisher":"https:\/\/www.facebook.com\/3DCoat","article_modified_time":"2023-11-08T11:15:26+00:00","og_image":[{"url":"https:\/\/3dcoat.com\/files\/3dcoat\/CoreAPI\/core_api_start.png","type":"","width":"","height":""}],"twitter_card":"summary_large_image","twitter_site":"@3DCoatOfficial","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/","url":"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/","name":"Core API - 3DCoat Documentation","isPartOf":{"@id":"https:\/\/3dcoat.com\/documentation\/#website"},"primaryImageOfPage":{"@id":"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/#primaryimage"},"image":{"@id":"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/#primaryimage"},"thumbnailUrl":"https:\/\/3dcoat.com\/files\/3dcoat\/CoreAPI\/core_api_start.png","datePublished":"2022-09-24T09:35:22+00:00","dateModified":"2023-11-08T11:15:26+00:00","description":"Core API\u4e2d\u7684\u57fa\u672c\u4f7f\u7528\u539f\u7406\u8bf4\u660e\u3002\u4ee5\u53caCore API\u6587\u6863\u4e3b\u8981\u90e8\u5206\u7684\u94fe\u63a5","breadcrumb":{"@id":"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/#primaryimage","url":"https:\/\/3dcoat.com\/files\/3dcoat\/CoreAPI\/core_api_start.png","contentUrl":"https:\/\/3dcoat.com\/files\/3dcoat\/CoreAPI\/core_api_start.png"},{"@type":"BreadcrumbList","@id":"https:\/\/3dcoat.com\/documentation\/zh_CN\/manual\/scripting-and-core-api\/core-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/3dcoat.com\/documentation\/nl_NL\/"},{"@type":"ListItem","position":2,"name":"Scripting & Core API","item":"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/"},{"@type":"ListItem","position":3,"name":"Core API"}]},{"@type":"WebSite","@id":"https:\/\/3dcoat.com\/documentation\/#website","url":"https:\/\/3dcoat.com\/documentation\/","name":"3DCoat Documentation","description":"Information about starting to use and learning how to use all the features of the 3DCoat.","publisher":{"@id":"https:\/\/3dcoat.com\/documentation\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/3dcoat.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/3dcoat.com\/documentation\/#organization","name":"Pilgway","url":"https:\/\/3dcoat.com\/documentation\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/3dcoat.com\/documentation\/#\/schema\/logo\/image\/","url":"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/09\/logo3DCoatWhite-1.png","contentUrl":"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/09\/logo3DCoatWhite-1.png","width":876,"height":190,"caption":"Pilgway"},"image":{"@id":"https:\/\/3dcoat.com\/documentation\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/3DCoat","https:\/\/x.com\/3DCoatOfficial","https:\/\/www.youtube.com\/c\/PILGWAY3DCoat"]}]}},"_links":{"self":[{"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_documentation\/2521","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_documentation"}],"about":[{"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/types\/manual_documentation"}],"author":[{"embeddable":true,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/users\/3"}],"version-history":[{"count":10,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_documentation\/2521\/revisions"}],"predecessor-version":[{"id":7195,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_documentation\/2521\/revisions\/7195"}],"up":[{"embeddable":true,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_documentation\/2379"}],"wp:attachment":[{"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/media?parent=2521"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manualdocumentationcategory?post=2521"},{"taxonomy":"manual_doc_tag","embeddable":true,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_doc_tag?post=2521"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}