One Logo Pool Ball
X
Github
Discord

System

SceneKit · IOS API REFERENCE

SCNParticleSystem

class · SDK 27.1

class SCNParticleSystem

Members (132)

init

init

TypeScript
static init(name: string, directory?: (string) | null): (SCNParticleSystem) | null
Swift declaration
convenience init?(named name: String, inDirectory directory: String?)
method

removeAllModifiers

TypeScript
removeAllModifiers(): void
Swift declaration
func removeAllModifiers()
method

removeModifiers

TypeScript
removeModifiers(stage: SCNParticleModifierStage): void
Swift declaration
func removeModifiers(at stage: SCNParticleModifierStage)
method

reset

TypeScript
reset(): void
Swift declaration
func reset()
get

acceleration

TypeScript
get acceleration(): SCNVector3
Swift declaration
var acceleration: SCNVector3 { get set }
set

acceleration

TypeScript
set acceleration(value: SCNVector3)
Swift declaration
var acceleration: SCNVector3 { get set }
get

isAffectedByGravity

TypeScript
get isAffectedByGravity(): boolean
Swift declaration
var isAffectedByGravity: Bool { get set }
set

isAffectedByGravity

TypeScript
set isAffectedByGravity(value: boolean)
Swift declaration
var isAffectedByGravity: Bool { get set }
get

isAffectedByPhysicsFields

TypeScript
get isAffectedByPhysicsFields(): boolean
Swift declaration
var isAffectedByPhysicsFields: Bool { get set }
set

isAffectedByPhysicsFields

TypeScript
set isAffectedByPhysicsFields(value: boolean)
Swift declaration
var isAffectedByPhysicsFields: Bool { get set }
get

birthDirection

TypeScript
get birthDirection(): SCNParticleBirthDirection
Swift declaration
var birthDirection: SCNParticleBirthDirection { get set }
set

birthDirection

TypeScript
set birthDirection(value: SCNParticleBirthDirection)
Swift declaration
var birthDirection: SCNParticleBirthDirection { get set }
get

birthLocation

TypeScript
get birthLocation(): SCNParticleBirthLocation
Swift declaration
var birthLocation: SCNParticleBirthLocation { get set }
set

birthLocation

TypeScript
set birthLocation(value: SCNParticleBirthLocation)
Swift declaration
var birthLocation: SCNParticleBirthLocation { get set }
get

birthRate

TypeScript
get birthRate(): number
Swift declaration
var birthRate: CGFloat { get set }
set

birthRate

TypeScript
set birthRate(value: number)
Swift declaration
var birthRate: CGFloat { get set }
get

birthRateVariation

TypeScript
get birthRateVariation(): number
Swift declaration
var birthRateVariation: CGFloat { get set }
set

birthRateVariation

TypeScript
set birthRateVariation(value: number)
Swift declaration
var birthRateVariation: CGFloat { get set }
get

isBlackPassEnabled

TypeScript
get isBlackPassEnabled(): boolean
Swift declaration
var isBlackPassEnabled: Bool { get set }
set

isBlackPassEnabled

TypeScript
set isBlackPassEnabled(value: boolean)
Swift declaration
var isBlackPassEnabled: Bool { get set }
get

blendMode

TypeScript
get blendMode(): SCNParticleBlendMode
Swift declaration
var blendMode: SCNParticleBlendMode { get set }
set

blendMode

TypeScript
set blendMode(value: SCNParticleBlendMode)
Swift declaration
var blendMode: SCNParticleBlendMode { get set }
get

colliderNodes

TypeScript
get colliderNodes(): (Array<SCNNode>) | null
Swift declaration
var colliderNodes: [SCNNode]? { get set }
set

colliderNodes

TypeScript
set colliderNodes(value: (Array<SCNNode>) | null)
Swift declaration
var colliderNodes: [SCNNode]? { get set }
get

dampingFactor

TypeScript
get dampingFactor(): number
Swift declaration
var dampingFactor: CGFloat { get set }
set

dampingFactor

TypeScript
set dampingFactor(value: number)
Swift declaration
var dampingFactor: CGFloat { get set }
get

emissionDuration

TypeScript
get emissionDuration(): number
Swift declaration
var emissionDuration: CGFloat { get set }
set

emissionDuration

TypeScript
set emissionDuration(value: number)
Swift declaration
var emissionDuration: CGFloat { get set }
get

emissionDurationVariation

TypeScript
get emissionDurationVariation(): number
Swift declaration
var emissionDurationVariation: CGFloat { get set }
set

emissionDurationVariation

TypeScript
set emissionDurationVariation(value: number)
Swift declaration
var emissionDurationVariation: CGFloat { get set }
get

emitterShape

TypeScript
get emitterShape(): (SCNGeometry) | null
Swift declaration
var emitterShape: SCNGeometry? { get set }
set

emitterShape

TypeScript
set emitterShape(value: (SCNGeometry) | null)
Swift declaration
var emitterShape: SCNGeometry? { get set }
get

emittingDirection

TypeScript
get emittingDirection(): SCNVector3
Swift declaration
var emittingDirection: SCNVector3 { get set }
set

emittingDirection

TypeScript
set emittingDirection(value: SCNVector3)
Swift declaration
var emittingDirection: SCNVector3 { get set }
get

fresnelExponent

TypeScript
get fresnelExponent(): number
Swift declaration
var fresnelExponent: CGFloat { get set }
set

fresnelExponent

TypeScript
set fresnelExponent(value: number)
Swift declaration
var fresnelExponent: CGFloat { get set }
get

idleDuration

TypeScript
get idleDuration(): number
Swift declaration
var idleDuration: CGFloat { get set }
set

idleDuration

TypeScript
set idleDuration(value: number)
Swift declaration
var idleDuration: CGFloat { get set }
get

idleDurationVariation

TypeScript
get idleDurationVariation(): number
Swift declaration
var idleDurationVariation: CGFloat { get set }
set

idleDurationVariation

TypeScript
set idleDurationVariation(value: number)
Swift declaration
var idleDurationVariation: CGFloat { get set }
get

imageSequenceAnimationMode

TypeScript
get imageSequenceAnimationMode(): SCNParticleImageSequenceAnimationMode
Swift declaration
var imageSequenceAnimationMode: SCNParticleImageSequenceAnimationMode { get set }
set

imageSequenceAnimationMode

TypeScript
set imageSequenceAnimationMode(value: SCNParticleImageSequenceAnimationMode)
Swift declaration
var imageSequenceAnimationMode: SCNParticleImageSequenceAnimationMode { get set }
get

imageSequenceColumnCount

TypeScript
get imageSequenceColumnCount(): number
Swift declaration
var imageSequenceColumnCount: Int { get set }
set

imageSequenceColumnCount

TypeScript
set imageSequenceColumnCount(value: number)
Swift declaration
var imageSequenceColumnCount: Int { get set }
get

imageSequenceFrameRate

TypeScript
get imageSequenceFrameRate(): number
Swift declaration
var imageSequenceFrameRate: CGFloat { get set }
set

imageSequenceFrameRate

TypeScript
set imageSequenceFrameRate(value: number)
Swift declaration
var imageSequenceFrameRate: CGFloat { get set }
get

imageSequenceFrameRateVariation

TypeScript
get imageSequenceFrameRateVariation(): number
Swift declaration
var imageSequenceFrameRateVariation: CGFloat { get set }
set

imageSequenceFrameRateVariation

TypeScript
set imageSequenceFrameRateVariation(value: number)
Swift declaration
var imageSequenceFrameRateVariation: CGFloat { get set }
get

imageSequenceInitialFrame

TypeScript
get imageSequenceInitialFrame(): number
Swift declaration
var imageSequenceInitialFrame: CGFloat { get set }
set

imageSequenceInitialFrame

TypeScript
set imageSequenceInitialFrame(value: number)
Swift declaration
var imageSequenceInitialFrame: CGFloat { get set }
get

imageSequenceInitialFrameVariation

TypeScript
get imageSequenceInitialFrameVariation(): number
Swift declaration
var imageSequenceInitialFrameVariation: CGFloat { get set }
set

imageSequenceInitialFrameVariation

TypeScript
set imageSequenceInitialFrameVariation(value: number)
Swift declaration
var imageSequenceInitialFrameVariation: CGFloat { get set }
get

imageSequenceRowCount

TypeScript
get imageSequenceRowCount(): number
Swift declaration
var imageSequenceRowCount: Int { get set }
set

imageSequenceRowCount

TypeScript
set imageSequenceRowCount(value: number)
Swift declaration
var imageSequenceRowCount: Int { get set }
get

isLightingEnabled

TypeScript
get isLightingEnabled(): boolean
Swift declaration
var isLightingEnabled: Bool { get set }
set

isLightingEnabled

TypeScript
set isLightingEnabled(value: boolean)
Swift declaration
var isLightingEnabled: Bool { get set }
get

isLocal

TypeScript
get isLocal(): boolean
Swift declaration
var isLocal: Bool { get set }
set

isLocal

TypeScript
set isLocal(value: boolean)
Swift declaration
var isLocal: Bool { get set }
get

loops

TypeScript
get loops(): boolean
Swift declaration
var loops: Bool { get set }
set

loops

TypeScript
set loops(value: boolean)
Swift declaration
var loops: Bool { get set }
get · iOS 11.0+

orientationDirection

TypeScript
get orientationDirection(): SCNVector3
Swift declaration
var orientationDirection: SCNVector3 { get set }
set · iOS 11.0+

orientationDirection

TypeScript
set orientationDirection(value: SCNVector3)
Swift declaration
var orientationDirection: SCNVector3 { get set }
get

orientationMode

TypeScript
get orientationMode(): SCNParticleOrientationMode
Swift declaration
var orientationMode: SCNParticleOrientationMode { get set }
set

orientationMode

TypeScript
set orientationMode(value: SCNParticleOrientationMode)
Swift declaration
var orientationMode: SCNParticleOrientationMode { get set }
get

particleAngle

TypeScript
get particleAngle(): number
Swift declaration
var particleAngle: CGFloat { get set }
set

particleAngle

TypeScript
set particleAngle(value: number)
Swift declaration
var particleAngle: CGFloat { get set }
get

particleAngleVariation

TypeScript
get particleAngleVariation(): number
Swift declaration
var particleAngleVariation: CGFloat { get set }
set

particleAngleVariation

TypeScript
set particleAngleVariation(value: number)
Swift declaration
var particleAngleVariation: CGFloat { get set }
get

particleAngularVelocity

TypeScript
get particleAngularVelocity(): number
Swift declaration
var particleAngularVelocity: CGFloat { get set }
set

particleAngularVelocity

TypeScript
set particleAngularVelocity(value: number)
Swift declaration
var particleAngularVelocity: CGFloat { get set }
get

particleAngularVelocityVariation

TypeScript
get particleAngularVelocityVariation(): number
Swift declaration
var particleAngularVelocityVariation: CGFloat { get set }
set

particleAngularVelocityVariation

TypeScript
set particleAngularVelocityVariation(value: number)
Swift declaration
var particleAngularVelocityVariation: CGFloat { get set }
get

particleBounce

TypeScript
get particleBounce(): number
Swift declaration
var particleBounce: CGFloat { get set }
set

particleBounce

TypeScript
set particleBounce(value: number)
Swift declaration
var particleBounce: CGFloat { get set }
get

particleBounceVariation

TypeScript
get particleBounceVariation(): number
Swift declaration
var particleBounceVariation: CGFloat { get set }
set

particleBounceVariation

TypeScript
set particleBounceVariation(value: number)
Swift declaration
var particleBounceVariation: CGFloat { get set }
get

particleCharge

TypeScript
get particleCharge(): number
Swift declaration
var particleCharge: CGFloat { get set }
set

particleCharge

TypeScript
set particleCharge(value: number)
Swift declaration
var particleCharge: CGFloat { get set }
get

particleChargeVariation

TypeScript
get particleChargeVariation(): number
Swift declaration
var particleChargeVariation: CGFloat { get set }
set

particleChargeVariation

TypeScript
set particleChargeVariation(value: number)
Swift declaration
var particleChargeVariation: CGFloat { get set }
get

particleColor

TypeScript
get particleColor(): _UIKit_UIColor
Swift declaration
var particleColor: UIColor { get set }
set

particleColor

TypeScript
set particleColor(value: _UIKit_UIColor)
Swift declaration
var particleColor: UIColor { get set }
get

particleColorVariation

TypeScript
get particleColorVariation(): SCNVector4
Swift declaration
var particleColorVariation: SCNVector4 { get set }
set

particleColorVariation

TypeScript
set particleColorVariation(value: SCNVector4)
Swift declaration
var particleColorVariation: SCNVector4 { get set }
get

particleDiesOnCollision

TypeScript
get particleDiesOnCollision(): boolean
Swift declaration
var particleDiesOnCollision: Bool { get set }
set

particleDiesOnCollision

TypeScript
set particleDiesOnCollision(value: boolean)
Swift declaration
var particleDiesOnCollision: Bool { get set }
get

particleFriction

TypeScript
get particleFriction(): number
Swift declaration
var particleFriction: CGFloat { get set }
set

particleFriction

TypeScript
set particleFriction(value: number)
Swift declaration
var particleFriction: CGFloat { get set }
get

particleFrictionVariation

TypeScript
get particleFrictionVariation(): number
Swift declaration
var particleFrictionVariation: CGFloat { get set }
set

particleFrictionVariation

TypeScript
set particleFrictionVariation(value: number)
Swift declaration
var particleFrictionVariation: CGFloat { get set }
get

particleImage

TypeScript
get particleImage(): (unknown) | null
Swift declaration
var particleImage: Any? { get set }
set

particleImage

TypeScript
set particleImage(value: (unknown) | null)
Swift declaration
var particleImage: Any? { get set }
get · iOS 11.0+

particleIntensity

TypeScript
get particleIntensity(): number
Swift declaration
var particleIntensity: CGFloat { get set }
set · iOS 11.0+

particleIntensity

TypeScript
set particleIntensity(value: number)
Swift declaration
var particleIntensity: CGFloat { get set }
get · iOS 11.0+

particleIntensityVariation

TypeScript
get particleIntensityVariation(): number
Swift declaration
var particleIntensityVariation: CGFloat { get set }
set · iOS 11.0+

particleIntensityVariation

TypeScript
set particleIntensityVariation(value: number)
Swift declaration
var particleIntensityVariation: CGFloat { get set }
get

particleLifeSpan

TypeScript
get particleLifeSpan(): number
Swift declaration
var particleLifeSpan: CGFloat { get set }
set

particleLifeSpan

TypeScript
set particleLifeSpan(value: number)
Swift declaration
var particleLifeSpan: CGFloat { get set }
get

particleLifeSpanVariation

TypeScript
get particleLifeSpanVariation(): number
Swift declaration
var particleLifeSpanVariation: CGFloat { get set }
set

particleLifeSpanVariation

TypeScript
set particleLifeSpanVariation(value: number)
Swift declaration
var particleLifeSpanVariation: CGFloat { get set }
get

particleMass

TypeScript
get particleMass(): number
Swift declaration
var particleMass: CGFloat { get set }
set

particleMass

TypeScript
set particleMass(value: number)
Swift declaration
var particleMass: CGFloat { get set }
get

particleMassVariation

TypeScript
get particleMassVariation(): number
Swift declaration
var particleMassVariation: CGFloat { get set }
set

particleMassVariation

TypeScript
set particleMassVariation(value: number)
Swift declaration
var particleMassVariation: CGFloat { get set }
get

particleSize

TypeScript
get particleSize(): number
Swift declaration
var particleSize: CGFloat { get set }
set

particleSize

TypeScript
set particleSize(value: number)
Swift declaration
var particleSize: CGFloat { get set }
get

particleSizeVariation

TypeScript
get particleSizeVariation(): number
Swift declaration
var particleSizeVariation: CGFloat { get set }
set

particleSizeVariation

TypeScript
set particleSizeVariation(value: number)
Swift declaration
var particleSizeVariation: CGFloat { get set }
get

particleVelocity

TypeScript
get particleVelocity(): number
Swift declaration
var particleVelocity: CGFloat { get set }
set

particleVelocity

TypeScript
set particleVelocity(value: number)
Swift declaration
var particleVelocity: CGFloat { get set }
get

particleVelocityVariation

TypeScript
get particleVelocityVariation(): number
Swift declaration
var particleVelocityVariation: CGFloat { get set }
set

particleVelocityVariation

TypeScript
set particleVelocityVariation(value: number)
Swift declaration
var particleVelocityVariation: CGFloat { get set }
get

propertyControllers

TypeScript
get propertyControllers(): (NativeMap<SCNParticleSystem_ParticleProperty, SCNParticlePropertyController>) | null
Swift declaration
var propertyControllers: [SCNParticleSystem.ParticleProperty : SCNParticlePropertyController]? { get set }
set

propertyControllers

TypeScript
set propertyControllers(value: (NativeMap<SCNParticleSystem_ParticleProperty, SCNParticlePropertyController>) | null)
Swift declaration
var propertyControllers: [SCNParticleSystem.ParticleProperty : SCNParticlePropertyController]? { get set }
get

sortingMode

TypeScript
get sortingMode(): SCNParticleSortingMode
Swift declaration
var sortingMode: SCNParticleSortingMode { get set }
set

sortingMode

TypeScript
set sortingMode(value: SCNParticleSortingMode)
Swift declaration
var sortingMode: SCNParticleSortingMode { get set }
get

speedFactor

TypeScript
get speedFactor(): number
Swift declaration
var speedFactor: CGFloat { get set }
set

speedFactor

TypeScript
set speedFactor(value: number)
Swift declaration
var speedFactor: CGFloat { get set }
get

spreadingAngle

TypeScript
get spreadingAngle(): number
Swift declaration
var spreadingAngle: CGFloat { get set }
set

spreadingAngle

TypeScript
set spreadingAngle(value: number)
Swift declaration
var spreadingAngle: CGFloat { get set }
get

stretchFactor

TypeScript
get stretchFactor(): number
Swift declaration
var stretchFactor: CGFloat { get set }
set

stretchFactor

TypeScript
set stretchFactor(value: number)
Swift declaration
var stretchFactor: CGFloat { get set }
get

systemSpawnedOnCollision

TypeScript
get systemSpawnedOnCollision(): (SCNParticleSystem) | null
Swift declaration
var systemSpawnedOnCollision: SCNParticleSystem? { get set }
set

systemSpawnedOnCollision

TypeScript
set systemSpawnedOnCollision(value: (SCNParticleSystem) | null)
Swift declaration
var systemSpawnedOnCollision: SCNParticleSystem? { get set }
get

systemSpawnedOnDying

TypeScript
get systemSpawnedOnDying(): (SCNParticleSystem) | null
Swift declaration
var systemSpawnedOnDying: SCNParticleSystem? { get set }
set

systemSpawnedOnDying

TypeScript
set systemSpawnedOnDying(value: (SCNParticleSystem) | null)
Swift declaration
var systemSpawnedOnDying: SCNParticleSystem? { get set }
get

systemSpawnedOnLiving

TypeScript
get systemSpawnedOnLiving(): (SCNParticleSystem) | null
Swift declaration
var systemSpawnedOnLiving: SCNParticleSystem? { get set }
set

systemSpawnedOnLiving

TypeScript
set systemSpawnedOnLiving(value: (SCNParticleSystem) | null)
Swift declaration
var systemSpawnedOnLiving: SCNParticleSystem? { get set }
get

warmupDuration

TypeScript
get warmupDuration(): number
Swift declaration
var warmupDuration: CGFloat { get set }
set

warmupDuration

TypeScript
set warmupDuration(value: number)
Swift declaration
var warmupDuration: CGFloat { get set }
get · iOS 15.0+

writesToDepthBuffer

TypeScript
get writesToDepthBuffer(): boolean
Swift declaration
var writesToDepthBuffer: Bool { get set }
set · iOS 15.0+

writesToDepthBuffer

TypeScript
set writesToDepthBuffer(value: boolean)
Swift declaration
var writesToDepthBuffer: Bool { get set }

Skipped declarations

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

SCNParticleSystem.handle(_:forProperties:handler:)

Nested memory pointers cannot cross the bridge.

SCNParticleSystem.addModifier(forProperties:at:modifier:)

Nested memory pointers cannot cross the bridge.

SCNParticleSystem.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All SceneKit types →