USDKit · IOS API REFERENCE

USDPrim.Predicate

struct · iOS 27.0+ · SDK 27.1

struct Predicate

A filter which returns true or false for prims based on their flags. A predicate checks flags on a ``USDPrim`` and can require that each flag is set or not set. ```swift let loadedModels = prim.children(where: [.isModel, .isLoaded]) let inactiveGroups = prim.children(where: [.isGroup, !.isActive]) ```

Members (12)

get · iOS 27.0+

isAbstract

TypeScript

static get isAbstract(): USDPrim_Predicate

Swift declaration

static var isAbstract: USDPrim.Predicate { get }

True if the prim or any of its ancestors are a class.

get · iOS 27.0+

isInstance

TypeScript

static get isInstance(): USDPrim_Predicate

Swift declaration

static var isInstance: USDPrim.Predicate { get }

True if the prim is an instance of a prototype.

get · iOS 27.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A summary description of this predicate.

get · iOS 27.0+

isComponent

TypeScript

static get isComponent(): USDPrim_Predicate

Swift declaration

static var isComponent: USDPrim.Predicate { get }

Returns true if this prim's kind metadata identifies it as a model component.

get · iOS 27.0+

hasDefSpecifier

TypeScript

static get hasDefSpecifier(): USDPrim_Predicate

Swift declaration

static var hasDefSpecifier: USDPrim.Predicate { get }

True if the prim has a def specifier. This flag is set if the prim's ``USDPrim/specifier`` is ``USDPrim/Specifier/def``.

get · iOS 27.0+

all

TypeScript

static get all(): USDPrim_Predicate

Swift declaration

static var all: USDPrim.Predicate { get }

A predicate which is always true, and accepts all prims.

get · iOS 27.0+

none

TypeScript

static get none(): USDPrim_Predicate

Swift declaration

static var none: USDPrim.Predicate { get }

A predicate which is always false, and accepts no prims.

get · iOS 27.0+

isGroup

TypeScript

static get isGroup(): USDPrim_Predicate

Swift declaration

static var isGroup: USDPrim.Predicate { get }

Returns true if this prim's kind metadata identifies it as a model group. If this prim is a model group, it is always a model.

get · iOS 27.0+

isModel

TypeScript

static get isModel(): USDPrim_Predicate

Swift declaration

static var isModel: USDPrim.Predicate { get }

Returns true if this prim's kind metadata identifies it as a model.

get · iOS 27.0+

isActive

TypeScript

static get isActive(): USDPrim_Predicate

Swift declaration

static var isActive: USDPrim.Predicate { get }

True if the prim and all of its ancestors are active.

get · iOS 27.0+

isLoaded

TypeScript

static get isLoaded(): USDPrim_Predicate

Swift declaration

static var isLoaded: USDPrim.Predicate { get }

True if the prim is active and none of its loadable ancestors are unloaded.

get · iOS 27.0+

isDefined

TypeScript

static get isDefined(): USDPrim_Predicate

Swift declaration

static var isDefined: USDPrim.Predicate { get }

True if the prim and all its ancestors have a `def` specifier.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

USDPrim.Predicate.init(arrayLiteral:)

A variable number of Swift arguments is not supported.

All USDKit types →