CKConfiguration

public final class CKConfiguration

A collection of properties used by CubeKit.

Important

CKConfiguration is an object singleton. The shared instance is stored in static shared property.

Note

By default the CKConfiguration.shared object is set to auto.

// Tells CubeKit to use iPhone prefab configuration.
CKConfiguration.shared = .iPhone
  • The shared configuration object used by CubeKit. Default to associated device preset.

    Declaration

    Swift

    public static var shared: CKConfiguration
  • Returns the CKConfiguration object associated with current device.

    Declaration

    Swift

    public class var auto: CKConfiguration { get }
  • Returns a new default CKConfiguration object.

    Declaration

    Swift

    public class var `default`: CKConfiguration { get }
  • Returns a new iPhone mode CKConfiguration object.

    Declaration

    Swift

    public class var iPhone: CKConfiguration { get }
  • Returns a new iPad mode CKConfiguration object.

    Declaration

    Swift

    public class var iPad: CKConfiguration { get }
  • mac

    Returns a new mac mode CKConfiguration object.

    Declaration

    Swift

    public class var mac: CKConfiguration { get }
  • The root global parent node name into scene. Default to scene. Convention CKScene Guide

    Declaration

    Swift

    public var sceneEntry: String
  • The default postion of root global parent node. Default to (0, 0, 0)

    Declaration

    Swift

    public var sceneEntryPosition: SCNVector3
  • Boolean value indicating to CKARCube to allow user to place scene.

  • Boolean value indicating to CKARCube to allow user to translate scene onto surface.

  • Boolean value indicating to CKARCube to allow user to scale scene.

  • Boolean value indicating to CKARCube to allow user to rotate scene onto surface.

  • The default scene scale displayed when CKARCube did place scene.

  • The min and max scale factor limit applied to zoom in CKARCube in percentage.

  • A list of nodes names into scene that will not be inserted into ar cube when *CKARCube did place scene. Default contains floor, base and support.