Reference API Roblox

Engine API

Website

Related

Reference API Roblox

WrapDeformer

Allows for the real-time deformation of a MeshPart.

Memory categoryInstances

Member index 3

HistoryMember
648CreateEditableMeshAsync(): Object
647GetDeformedCFrameAsync(originalCFrame: CFrame): CFrame
648SetCageMeshContent(content: Content): null
inherited from BaseWrap
645CageMeshId: ContentId
553CageOrigin: CFrame
553CageOriginWorld: CFrame
645HSRAssetId: ContentId
553ImportOrigin: CFrame
553ImportOriginWorld: CFrame
603GetCageOffset(): Vector3
475GetFaces(cageType: CageType): Array
629GetUVs(cageType: CageType): Array
475GetVertices(cageType: CageType): Array
499IsHSRReady(): bool
573ModifyVertices(cageType: CageType, vertices: Array): null
639VerticesModified(vertices: Array)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 4

HistoryMember
646Amount: float
646Enabled: bool
646RenderMeshID: ContentId
647GetDeformedCFrame(originalCFrame: CFrame): CFrame

Description

The WrapDeformer object provides a low-resolution cage mesh that pairs with a WrapTarget sibling to deform a parent MeshPart. The MeshPart geometry is deformed according to the displacement between pairs of WrapTarget cage mesh vertices and WrapDeformer cage mesh vertices. Cage mesh vertices are paired based on UV equivalence.

WrapDeformer may be used with avatars or on distinct MeshParts, as long as WrapTarget children are present for the parent MeshParts. WrapDeformer is similar to WrapLayer but doesn't require layered clothing and can directly deform MeshParts for publishing.

History 15

Members 3

CreateEditableMeshAsync

Parameters (0)
No parameters.
Returns (1)
Object

Constructs and returns an EditableMesh corresponding to the deformed parent mesh geometry. This method respects all updates made to the deformation inputs prior to the request. It also sets the returned result's FixedSize to true.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields]

GetDeformedCFrameAsync

Parameters (1)
originalCFrameCFrame
Returns (1)
CFrame

Returns a CFrame deformed by the same deformation field used for the geometry of the parent MeshPart. This method is useful for the placement of accessories.

The input and output CFrame are both in the space of the parent MeshPart; only position (not rotation) will be deformed. This method respects all updates made to the deformation inputs prior to the request.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

SetCageMeshContent

Parameters (1)
contentContent
Returns (1)
null

Sets the cage mesh used to deform the parent MeshPart in conjunction with a sibling WrapTarget cage mesh. The content parameter should represent a Roblox mesh asset ID or an EditableMesh reference in your DataModel.

Thread safetyUnsafe

History 1

Removed members 4

Amount

TypeDefault
float1
Write securityPluginSecurity
Thread safetyReadSafe
CategoryTuning
Loaded/Savedtrue

History 2

Enabled

TypeDefault
booltrue
Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 2

GetDeformedCFrame

Parameters (1)
originalCFrameCFrame
Returns (1)
CFrame
Thread safetyUnsafe

History 2

RenderMeshID

TypeDefault
ContentId
Write securityPluginSecurity
Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 3

Settings