Meta Developers

MR Utility Kit v68 Reference Guide

Unity

Select your SDK

Overview

FindSpawnPositions

EffectMesh Class

Meta::XR::MRUtilityKit::EffectMesh extends MonoBehaviour.

See Also:

Overview

Public Types

enum	WallTextureCoordinateModeU { WallTextureCoordinateModeU.METRIC , WallTextureCoordinateModeU.METRIC_SEAMLESS , WallTextureCoordinateModeU.MAINTAIN_ASPECT_RATIO , WallTextureCoordinateModeU.MAINTAIN_ASPECT_RATIO_SEAMLESS , WallTextureCoordinateModeU.STRETCH , WallTextureCoordinateModeU.STRETCH_SECTION }
enum	WallTextureCoordinateModeV { WallTextureCoordinateModeV.METRIC , WallTextureCoordinateModeV.MAINTAIN_ASPECT_RATIO , WallTextureCoordinateModeV.STRETCH }
enum	AnchorTextureCoordinateMode { AnchorTextureCoordinateMode.METRIC , AnchorTextureCoordinateMode.STRETCH }

Data Fields

MRUK.RoomFilter	SpawnOnStart`[Get]`
Material	MeshMaterial`[Get]`
float	BorderSize`[Get]`
bool	Colliders`[Get]`
MRUKAnchor.SceneLabels	CutHoles`[Get]`
int	Layer`[Get]`
TextureCoordinateModes[]	textureCoordinateModes`[Get]`
MRUKAnchor.SceneLabels	Labels`[Get]`

Properties

bool	CastShadow`[Get]`
bool	HideMesh`[Get]`
bool	ToggleColliders`[Get]`

Public Member Functions

Vector3	GetInsetPositionOffset ( Vector2 point1, Vector2 point2, Vector2 point3, float border ) For 2 walls defined by 3 corner points, get the inset position from the inside corner.
void	CreateMesh ( ) Creates effect mesh for all elements in all rooms.
void	DestroyMesh ( LabelFilter label ) Destroys mesh the objects instantiated based on the provided label filter.
void	DestroyMesh ( MRUKRoom room ) Destroys all meshs in the given room and mark the room as not tracked anymore by this class.
void	DestroyMesh ( MRUKAnchor anchor ) Destroys the meshs associated with the provided anchor and mark the anchor as not tracked anymore by this class.
void	AddColliders ( LabelFilter label ) Adds colliders to the mesh objects instantiated based on the provided label filter.
void	DestroyColliders ( LabelFilter label ) Destroy the colliders of the instantiated mesh objects based on the provided label filter.
void	ToggleShadowCasting ( bool shouldCast, LabelFilter label )
void	ToggleEffectMeshVisibility ( bool shouldShow, LabelFilter label, Material materialOverride ) Toggles the visibility of the effect mesh objects instantiated based on the provided label filter.
void	ToggleEffectMeshColliders ( bool doEnable, LabelFilter label ) Toggles the colliders of the effect mesh objects.
void	OverrideEffectMaterial ( Material newMaterial, LabelFilter label ) Overrides the material of the effect mesh objects instantiated based on the provided label filter.
void	CreateMesh ( MRUKRoom room ) Creates effect mesh for all objects in the given room.
EffectMeshObject	CreateEffectMesh ( MRUKAnchor anchorInfo )
void	SetEffectObjectsParent ( Transform newParent )

Details

Member Enumerations

enum Meta::XR::MRUtilityKit::EffectMesh.WallTextureCoordinateModeU

Enumerator

METRIC
METRIC_SEAMLESS
MAINTAIN_ASPECT_RATIO
MAINTAIN_ASPECT_RATIO_SEAMLESS
STRETCH
STRETCH_SECTION

enum Meta::XR::MRUtilityKit::EffectMesh.WallTextureCoordinateModeV

Enumerator

METRIC
MAINTAIN_ASPECT_RATIO
STRETCH

enum Meta::XR::MRUtilityKit::EffectMesh.AnchorTextureCoordinateMode

Enumerator

METRIC
STRETCH

Fields

MRUK.RoomFilter Meta.XR.MRUtilityKit.EffectMesh.SpawnOnStart
No description available.

Material Meta.XR.MRUtilityKit.EffectMesh.MeshMaterial
No description available.

float Meta.XR.MRUtilityKit.EffectMesh.BorderSize
No description available.

bool Meta.XR.MRUtilityKit.EffectMesh.Colliders
No description available.

MRUKAnchor.SceneLabels Meta.XR.MRUtilityKit.EffectMesh.CutHoles
No description available.

int Meta.XR.MRUtilityKit.EffectMesh.Layer
No description available.

TextureCoordinateModes [] Meta.XR.MRUtilityKit.EffectMesh.textureCoordinateModes
No description available.

MRUKAnchor.SceneLabels Meta.XR.MRUtilityKit.EffectMesh.Labels
No description available.

Properties

bool Meta.XR.MRUtilityKit.EffectMesh.CastShadow
No description available.

bool Meta.XR.MRUtilityKit.EffectMesh.HideMesh
No description available.

bool Meta.XR.MRUtilityKit.EffectMesh.ToggleColliders
No description available.

Member Functions

Vector3 Meta.XR.MRUtilityKit.EffectMesh.GetInsetPositionOffset ( Vector2 point1, Vector2 point2, Vector2 point3, float border )
For 2 walls defined by 3 corner points, get the inset position from the inside corner. Inset Position is "border" meters away from the corner, and relative to point2 It will always point to the "inside" of the room

void Meta.XR.MRUtilityKit.EffectMesh.CreateMesh ( )
Creates effect mesh for all elements in all rooms.

void Meta.XR.MRUtilityKit.EffectMesh.DestroyMesh ( LabelFilter label )
Destroys mesh the objects instantiated based on the provided label filter. Parameters label The filter for mesh object destruction. If a mesh object's anchor labels pass this filter, the mesh object will be destroyed. Default value includes all labels.

void Meta.XR.MRUtilityKit.EffectMesh.DestroyMesh ( MRUKRoom room )
Destroys all meshs in the given room and mark the room as not tracked anymore by this class. Parameters room MRUK Room

void Meta.XR.MRUtilityKit.EffectMesh.DestroyMesh ( MRUKAnchor anchor )
Destroys the meshs associated with the provided anchor and mark the anchor as not tracked anymore by this class. Parameters anchor MRUK Anchor

void Meta.XR.MRUtilityKit.EffectMesh.AddColliders ( LabelFilter label )
Adds colliders to the mesh objects instantiated based on the provided label filter. Parameters label The filter to determine which mesh objects receive a collider. If a mesh object's anchor labels pass this filter and the mesh object does not already have a collider, a new collider is added. Default value includes all labels.

void Meta.XR.MRUtilityKit.EffectMesh.DestroyColliders ( LabelFilter label )
Destroy the colliders of the instantiated mesh objects based on the provided label filter. Parameters label The filter to determine which mesh objects receive a collider. If a mesh object's anchor labels pass this filter and the mesh object does not already have a collider, a new collider is added. Default value includes all labels.

void Meta.XR.MRUtilityKit.EffectMesh.ToggleShadowCasting ( bool shouldCast, LabelFilter label )
No description available.

void Meta.XR.MRUtilityKit.EffectMesh.ToggleEffectMeshVisibility ( bool shouldShow, LabelFilter label, Material materialOverride )
Toggles the visibility of the effect mesh objects instantiated based on the provided label filter. Parameters shouldShow Determines whether the effect mesh objects should be visible or not. label The filter to determine which effect mesh objects have their visibility toggled. If an effect mesh object's anchor labels pass this filter, its visibility is toggled according to the 'shouldShow' parameter. Default value includes all labels. materialOverride An optional material to apply to the effect mesh objects when their visibility is toggled. If not provided, the material of the mesh objects remains unchanged.

void Meta.XR.MRUtilityKit.EffectMesh.ToggleEffectMeshVisibility
( bool shouldShow,
LabelFilter label,
Material materialOverride )

Toggles the visibility of the effect mesh objects instantiated based on the provided label filter.

Parameters

shouldShow

Determines whether the effect mesh objects should be visible or not.

label

The filter to determine which effect mesh objects have their visibility toggled. If an effect mesh object's anchor labels pass this filter, its visibility is toggled according to the 'shouldShow' parameter. Default value includes all labels.

materialOverride

An optional material to apply to the effect mesh objects when their visibility is toggled. If not provided, the material of the mesh objects remains unchanged.

void Meta.XR.MRUtilityKit.EffectMesh.ToggleEffectMeshColliders ( bool doEnable, LabelFilter label )
Toggles the colliders of the effec