-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into remove-sgoldring-from-codeowners
- Loading branch information
Showing
786 changed files
with
794 additions
and
794 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
2 changes: 1 addition & 1 deletion
2
SpaceKit.doccarchive/data/documentation/spacekit/addingbuttons.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
{"metadata":{"title":"Adding Buttons and Actions","color":{"standardColorIdentifier":"blue"},"modules":[{"name":"SpaceKit"}],"images":[{"identifier":"hyper-wireframe-icon.png","type":"icon"}],"role":"article","roleHeading":"Article"},"sections":[],"hierarchy":{"paths":[["doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit"]]},"abstract":[{"type":"text","text":"A quick overview of how to add custom UI to a SpaceKit map."}],"identifier":{"url":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/AddingButtons","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/spacekit\/addingbuttons"]},{"traits":[{"interfaceLanguage":"occ"}],"paths":["\/documentation\/spacekit\/addingbuttons"]}],"kind":"article","primaryContentSections":[{"kind":"content","content":[{"type":"heading","text":"Overview","level":2,"anchor":"Overview"},{"inlineContent":[{"text":"You can customise SpaceKit with buttons to trigger useful actions within your app. You do this by creating a ","type":"text"},{"overridingTitle":"SpaceKitActionButtonItem","overridingTitleInlineContent":[{"text":"SpaceKitActionButtonItem","type":"text"}],"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/SpaceKitActionButtonItem","isActive":true,"type":"reference"},{"text":" which is a model object representing your button and action.","type":"text"}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can then add the button to one of three button stacks within the SpaceKit screen."}]},{"anchor":"Positioning","level":2,"type":"heading","text":"Positioning"},{"inlineContent":[{"text":"SpaceViewController objects have a ","type":"text"},{"type":"reference","overridingTitleInlineContent":[{"type":"text","text":"mapViewControls"}],"isActive":true,"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/SpaceKitInterfaceControls","overridingTitle":"mapViewControls"},{"type":"text","text":" object that allows you to add or remove buttons to given button stacks. These button stacks are semantic and may change physical position depending on the device they are displayed on."}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"type":"image","identifier":"button-positions"}]},{"inlineContent":[{"type":"text","text":"These are the button stacks you can choose: -"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"text":".topNavigation","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":".primaryActions"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":".secondaryActions","type":"text"}]}]}],"type":"unorderedList"},{"level":3,"type":"heading","anchor":"Top-Navigation","text":"Top Navigation"},{"inlineContent":[{"text":"This is an area suitable for top-level navigation such as floor selectors and close buttons.","type":"text"}],"type":"paragraph"},{"text":"Primary Actions","anchor":"Primary-Actions","type":"heading","level":3},{"inlineContent":[{"type":"text","text":"This is an area suitable for primary actions the user would need quick access to, such as “find my location” buttons or shopping cart buttons."}],"type":"paragraph"},{"text":"Secondary Actions","level":3,"anchor":"Secondary-Actions","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"This is an area suitable for secondary actions such as searching and scanning product buttons. Place less-used buttons in this stack.","type":"text"}]},{"text":"Code Example","level":2,"type":"heading","anchor":"Code-Example"},{"type":"codeListing","code":["let spaceKitViewController = SpaceKit.StaticMapViewControllerFactory(context: spaceKitContext).make()","","let closeButtonItem = SpaceKitActionButtonItem("," title: NSLocalizedString(\"button.close\", comment: \"\"),"," systemImageName: \"xmark\"",") { _ in"," dismiss()","}","","spaceKitViewController.mapViewControls.add("," actionButtonItem: closeButtonItem,"," in: .topNavigation,"," at: .top",")"],"syntax":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"button-positions":{"type":"image","identifier":"button-positions","alt":"Button stack positions","variants":[{"url":"\/images\/[email protected]","traits":["3x","light"]},{"url":"\/images\/[email protected]","traits":["3x","dark"]}]},"doc://DentReality.SpaceKit/documentation/SpaceKit":{"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit","images":[{"type":"icon","identifier":"hyper-wireframe-icon.png"}],"type":"topic","title":"SpaceKit","url":"\/documentation\/spacekit","abstract":[{"type":"text","text":"Indoor location that actually works!"}],"kind":"symbol","role":"collection"},"doc://DentReality.SpaceKit/documentation/SpaceKit/SpaceKitActionButtonItem":{"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/SpaceKitActionButtonItem","role":"symbol","type":"topic","title":"SpaceKitActionButtonItem","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SpaceKitActionButtonItem","kind":"identifier"}],"url":"\/documentation\/spacekit\/spacekitactionbuttonitem","abstract":[{"type":"text","text":"A button that triggers an action for use inside the primary user interface for SpaceKit."}],"navigatorTitle":[{"kind":"identifier","text":"SpaceKitActionButtonItem"}],"kind":"symbol"},"doc://DentReality.SpaceKit/documentation/SpaceKit/SpaceKitInterfaceControls":{"kind":"symbol","abstract":[],"title":"SpaceKitInterfaceControls","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"SpaceKitInterfaceControls"}],"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/SpaceKitInterfaceControls","url":"\/documentation\/spacekit\/spacekitinterfacecontrols","role":"symbol","navigatorTitle":[{"text":"SpaceKitInterfaceControls","kind":"identifier"}],"type":"topic"},"hyper-wireframe-icon.png":{"type":"image","identifier":"hyper-wireframe-icon.png","variants":[{"url":"\/images\/hyper-wireframe-icon.png","traits":["1x","light"]}],"alt":"The Hyper logo"}},"variantOverrides":[{"patch":[{"value":"occ","path":"\/identifier\/interfaceLanguage","op":"replace"},{"op":"add","path":"\/topicSections","value":null},{"op":"add","path":"\/seeAlsoSections","value":null}],"traits":[{"interfaceLanguage":"occ"}]}]} | ||
{"hierarchy":{"paths":[["doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit"]]},"variants":[{"paths":["\/documentation\/spacekit\/addingbuttons"],"traits":[{"interfaceLanguage":"swift"}]},{"paths":["\/documentation\/spacekit\/addingbuttons"],"traits":[{"interfaceLanguage":"occ"}]}],"metadata":{"color":{"standardColorIdentifier":"blue"},"roleHeading":"Article","title":"Adding Buttons and Actions","images":[{"identifier":"hyper-wireframe-icon.png","type":"icon"}],"modules":[{"name":"SpaceKit"}],"role":"article"},"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/AddingButtons","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"content","content":[{"level":2,"text":"Overview","type":"heading","anchor":"Overview"},{"inlineContent":[{"type":"text","text":"You can customise SpaceKit with buttons to trigger useful actions within your app. You do this by creating a "},{"overridingTitle":"SpaceKitActionButtonItem","isActive":true,"type":"reference","overridingTitleInlineContent":[{"text":"SpaceKitActionButtonItem","type":"text"}],"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/SpaceKitActionButtonItem"},{"type":"text","text":" which is a model object representing your button and action."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"You can then add the button to one of three button stacks within the SpaceKit screen."}],"type":"paragraph"},{"level":2,"anchor":"Positioning","text":"Positioning","type":"heading"},{"inlineContent":[{"text":"SpaceViewController objects have a ","type":"text"},{"type":"reference","isActive":true,"overridingTitle":"mapViewControls","identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/SpaceKitInterfaceControls","overridingTitleInlineContent":[{"type":"text","text":"mapViewControls"}]},{"type":"text","text":" object that allows you to add or remove buttons to given button stacks. These button stacks are semantic and may change physical position depending on the device they are displayed on."}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"type":"image","identifier":"button-positions"}]},{"type":"paragraph","inlineContent":[{"text":"These are the button stacks you can choose: -","type":"text"}]},{"items":[{"content":[{"inlineContent":[{"text":".topNavigation","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":".primaryActions"}]}]},{"content":[{"inlineContent":[{"type":"text","text":".secondaryActions"}],"type":"paragraph"}]}],"type":"unorderedList"},{"type":"heading","text":"Top Navigation","level":3,"anchor":"Top-Navigation"},{"type":"paragraph","inlineContent":[{"text":"This is an area suitable for top-level navigation such as floor selectors and close buttons.","type":"text"}]},{"text":"Primary Actions","anchor":"Primary-Actions","level":3,"type":"heading"},{"inlineContent":[{"type":"text","text":"This is an area suitable for primary actions the user would need quick access to, such as “find my location” buttons or shopping cart buttons."}],"type":"paragraph"},{"type":"heading","level":3,"text":"Secondary Actions","anchor":"Secondary-Actions"},{"inlineContent":[{"text":"This is an area suitable for secondary actions such as searching and scanning product buttons. Place less-used buttons in this stack.","type":"text"}],"type":"paragraph"},{"text":"Code Example","level":2,"type":"heading","anchor":"Code-Example"},{"type":"codeListing","syntax":"swift","code":["let spaceKitViewController = SpaceKit.StaticMapViewControllerFactory(context: spaceKitContext).make()","","let closeButtonItem = SpaceKitActionButtonItem("," title: NSLocalizedString(\"button.close\", comment: \"\"),"," systemImageName: \"xmark\"",") { _ in"," dismiss()","}","","spaceKitViewController.mapViewControls.add("," actionButtonItem: closeButtonItem,"," in: .topNavigation,"," at: .top",")"]}]}],"sections":[],"abstract":[{"type":"text","text":"A quick overview of how to add custom UI to a SpaceKit map."}],"kind":"article","references":{"hyper-wireframe-icon.png":{"type":"image","variants":[{"traits":["1x","light"],"url":"\/images\/hyper-wireframe-icon.png"}],"identifier":"hyper-wireframe-icon.png","alt":"The Hyper logo"},"doc://DentReality.SpaceKit/documentation/SpaceKit/SpaceKitActionButtonItem":{"role":"symbol","kind":"symbol","url":"\/documentation\/spacekit\/spacekitactionbuttonitem","title":"SpaceKitActionButtonItem","type":"topic","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"kind":"identifier","text":"SpaceKitActionButtonItem"}],"navigatorTitle":[{"text":"SpaceKitActionButtonItem","kind":"identifier"}],"abstract":[{"type":"text","text":"A button that triggers an action for use inside the primary user interface for SpaceKit."}],"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/SpaceKitActionButtonItem"},"doc://DentReality.SpaceKit/documentation/SpaceKit":{"images":[{"identifier":"hyper-wireframe-icon.png","type":"icon"}],"abstract":[{"text":"Indoor location that actually works!","type":"text"}],"title":"SpaceKit","url":"\/documentation\/spacekit","kind":"symbol","identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit","role":"collection","type":"topic"},"button-positions":{"type":"image","alt":"Button stack positions","variants":[{"url":"\/images\/[email protected]","traits":["3x","light"]},{"url":"\/images\/[email protected]","traits":["3x","dark"]}],"identifier":"button-positions"},"doc://DentReality.SpaceKit/documentation/SpaceKit/SpaceKitInterfaceControls":{"role":"symbol","url":"\/documentation\/spacekit\/spacekitinterfacecontrols","kind":"symbol","type":"topic","title":"SpaceKitInterfaceControls","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"SpaceKitInterfaceControls","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SpaceKitInterfaceControls"}],"abstract":[],"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/SpaceKitInterfaceControls"}},"variantOverrides":[{"patch":[{"value":"occ","op":"replace","path":"\/identifier\/interfaceLanguage"},{"op":"add","path":"\/topicSections","value":null},{"path":"\/seeAlsoSections","value":null,"op":"add"}],"traits":[{"interfaceLanguage":"occ"}]}]} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
{"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"roleHeading":"Extended Module","role":"collection","title":"ARKit","modules":[{"name":"SpaceKit"}],"externalID":"s:m:s:e:s:So9ARSCNViewC8SpaceKitE16userSceneHeadingSfSgvp","symbolKind":"extension"},"identifier":{"url":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/ARKit","interfaceLanguage":"swift"},"sections":[],"variants":[{"paths":["\/documentation\/spacekit\/arkit"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"identifiers":["doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/ARKit\/ARSCNView"],"title":"Extended Classes"}],"hierarchy":{"paths":[["doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit"]]},"references":{"doc://DentReality.SpaceKit/documentation/SpaceKit/ARKit/ARSCNView":{"navigatorTitle":[{"text":"ARSCNView","kind":"identifier"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[],"fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"c:objc(cs)ARSCNView","text":"ARSCNView"}],"title":"ARSCNView","url":"\/documentation\/spacekit\/arkit\/arscnview","identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/ARKit\/ARSCNView"},"doc://DentReality.SpaceKit/documentation/SpaceKit/ARKit":{"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/ARKit","role":"collection","title":"ARKit","kind":"symbol","type":"topic","url":"\/documentation\/spacekit\/arkit","abstract":[]},"hyper-wireframe-icon.png":{"alt":"The Hyper logo","identifier":"hyper-wireframe-icon.png","variants":[{"url":"\/images\/hyper-wireframe-icon.png","traits":["1x","light"]}],"type":"image"},"doc://DentReality.SpaceKit/documentation/SpaceKit":{"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit","images":[{"type":"icon","identifier":"hyper-wireframe-icon.png"}],"type":"topic","title":"SpaceKit","url":"\/documentation\/spacekit","abstract":[{"type":"text","text":"Indoor location that actually works!"}],"kind":"symbol","role":"collection"}}} | ||
{"sections":[],"hierarchy":{"paths":[["doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit"]]},"metadata":{"title":"ARKit","role":"collection","symbolKind":"extension","roleHeading":"Extended Module","externalID":"s:m:s:e:s:So9ARSCNViewC8SpaceKitE16userSceneHeadingSfSgvp","modules":[{"name":"SpaceKit"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/ARKit"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/spacekit\/arkit"]}],"topicSections":[{"title":"Extended Classes","identifiers":["doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/ARKit\/ARSCNView"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","references":{"doc://DentReality.SpaceKit/documentation/SpaceKit/ARKit":{"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/ARKit","url":"\/documentation\/spacekit\/arkit","abstract":[],"role":"collection","kind":"symbol","title":"ARKit","type":"topic"},"doc://DentReality.SpaceKit/documentation/SpaceKit":{"images":[{"identifier":"hyper-wireframe-icon.png","type":"icon"}],"abstract":[{"text":"Indoor location that actually works!","type":"text"}],"title":"SpaceKit","url":"\/documentation\/spacekit","kind":"symbol","identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit","role":"collection","type":"topic"},"hyper-wireframe-icon.png":{"identifier":"hyper-wireframe-icon.png","type":"image","alt":"The Hyper logo","variants":[{"traits":["1x","light"],"url":"\/images\/hyper-wireframe-icon.png"}]},"doc://DentReality.SpaceKit/documentation/SpaceKit/ARKit/ARSCNView":{"type":"topic","title":"ARSCNView","role":"symbol","url":"\/documentation\/spacekit\/arkit\/arscnview","navigatorTitle":[{"text":"ARSCNView","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/DentReality.SpaceKit\/documentation\/SpaceKit\/ARKit\/ARSCNView","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"preciseIdentifier":"c:objc(cs)ARSCNView","text":"ARSCNView","kind":"identifier"}],"kind":"symbol"}}} |
Oops, something went wrong.