PolyToolkit

Summary

Enumerations

PolyAssetLicense{
  UNKNOWN = 0,
  CREATIVE_COMMONS_BY = 1,
  ALL_RIGHTS_RESERVED = 2
}
enum
Possible asset licenses.
PolyCategory enum
Category of a Poly asset.
PolyFormatFilter enum
Options for filtering to return only assets that contain the given format.
PolyFormatType enum
Possible format types that can be returned from the Poly REST API.
PolyMaxComplexityFilter enum
Options for filtering on the maximum complexity of the asset.
PolyOrderBy enum
How the requested assets should be ordered in the response.
PolyVisibility{
  UNSPECIFIED = 0,
  PRIVATE = 1,
  UNLISTED = 2,
  PUBLISHED = 3
}
enum
Visibility of a Poly asset.
PolyVisibilityFilter{
  UNSPECIFIED = 0,
  PRIVATE = 1,
  PUBLISHED = 2
}
enum
Visibility filters for a PolyListUserAssets request.

Classes

PolyToolkit.PolyApi

This is the main entry point for the Poly Toolkit Runtime API.

PolyToolkit.PolyAsset

Represents a Poly asset (the information about a 3D object in Poly).

PolyToolkit.PolyBaseResult

Base class for all result types.

PolyToolkit.PolyFile

Represents a Poly file.

PolyToolkit.PolyFormat

A specific representation of an asset, containing all the information needed to retrieve and describe this representation.

PolyToolkit.PolyFormatComplexity

Information on the complexity of a format.

PolyToolkit.PolyFormatTypeFetchResult

Represents the result of fetching files for an asset.

PolyToolkit.PolyImportResult

Represents the result of importing an asset.

PolyToolkit.PolyListAssetsRequest

Represents a set of Poly request parameters determining which assets should be returned.

PolyToolkit.PolyListAssetsResult

Represents the result of a PolyListAssetsRequest or PolyListUserAssetsRequest.

PolyToolkit.PolyListLikedAssetsRequest

Represents a set of Poly request parameters determining which liked assets should be returned.

PolyToolkit.PolyListUserAssetsRequest

Represents a set of Poly request parameters determining which of the user's assets should be returned.

PolyToolkit.PolyRequest

Base class that all request types derive from.

PolyToolkit.PolyStatusOr< T >

A union of a PolyStatus and a type.

PolyToolkit.PolyToolkitManager

Manages configuration and initialization of the Poly Toolkit.

PolyToolkit.PtAsset

A Poly Toolkit asset (custom asset type).

PolyToolkit.PtAssetObject

Added to an object to indicate that it's a prefab (or instance) of a Poly Toolkit asset.

Structs

PolyToolkit.PolyAuthConfig

Holds authentication configuration information.

PolyToolkit.PolyCacheConfig

Indicates how to configure the Poly Toolkit cache.

PolyToolkit.PolyImportOptions

Options that indicate how to import a given asset.

PolyToolkit.PolyStatus

Using PolyStatus vs.

Enumerations

PolyAssetLicense

 PolyAssetLicense

Possible asset licenses.

Properties
ALL_RIGHTS_RESERVED

All Rights Reserved by author (not licensed).

CREATIVE_COMMONS_BY

Creative Commons license.

UNKNOWN

License unknown/unspecified.

PolyCategory

 PolyCategory

Category of a Poly asset.

PolyFormatFilter

 PolyFormatFilter

Options for filtering to return only assets that contain the given format.

PolyFormatType

 PolyFormatType

Possible format types that can be returned from the Poly REST API.

PolyMaxComplexityFilter

 PolyMaxComplexityFilter

Options for filtering on the maximum complexity of the asset.

PolyOrderBy

 PolyOrderBy

How the requested assets should be ordered in the response.

PolyVisibility

 PolyVisibility

Visibility of a Poly asset.

Properties
PRIVATE

Only the owner of the asset can access it.

PUBLISHED

Read access for everyone.

UNLISTED

Read access to anyone who knows the asset ID (link to the asset), but the logged-in user's unlisted assets are returned in PolyListUserAssets.

UNSPECIFIED

Unknown (and invalid) visibility.

PolyVisibilityFilter

 PolyVisibilityFilter

Visibility filters for a PolyListUserAssets request.

Properties
PRIVATE

Return only private assets.

PUBLISHED

Return only published assets, including unlisted assets.

UNSPECIFIED

No visibility specified.

Returns all assets.