Sansar Docs
Ask or search…
K

Mesh Component

MeshComponent Class

The MeshComponent handles interactions with static meshes.

Syntax

Member Details

ComponentId Property

Retrieves the component id for this MeshComponent.

Syntax

Value
The id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

ComponentType Field

Syntax

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

GetIsVisible Method

Retrieves the visibility state of this MeshComponent.

Syntax

[Sansar.Script.Interface] public bool GetIsVisible ()
Returns
The visibility state.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

IsScriptable Property

The scriptable flag for this MeshComponent.

Syntax

[get: Sansar.Script.Interface] public bool IsScriptable { get; }
Value
Whether or not this mesh can have properties changed by script.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

Name Property

This MeshComponent name, as specified in the editor.

Syntax

[get: Sansar.Script.Interface] public string Name { get; }
Value

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

SetIsVisible Method

Sets the visibility state of this MeshComponent.

Syntax

[Sansar.Script.Interface] public void SetIsVisible (bool isVisible)
Parameters
isVisible
The visibility state to set.
Returns
The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

SetIsVisible Method

Sets the visibility state of this MeshComponent.

Syntax

Parameters
sessionId
The sessionId of the user to change static mesh visibility for.
isVisible
The visibility state to set.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

SetIsVisible Method

Sets the visibility state of this MeshComponent.

Syntax

[Sansar.Script.Interface] public void SetIsVisible (AgentPrivate agent, bool isVisible)
Parameters
agent
The agent to change static mesh visibility for.
isVisible
The visibility state to set.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

SetIsVisible Method

Sets the visibility state of this MeshComponent.

Syntax

Parameters
isVisible
The visibility state to set.
handler
Handler to be called when the event completes.
Returns
The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

SetIsVisible Method

Sets the visibility state of this MeshComponent.

Syntax

Parameters
sessionId
The sessionId of the user to change static mesh visibility for.
isVisible
The visibility state to set.
handler
Handler to be called when the event completes.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

SetIsVisible Method

Sets the visibility state of this MeshComponent.

Syntax

Parameters
agent
The agent to change static mesh visibility for.
isVisible
The visibility state to set.
handler
Handler to be called when the event completes.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

ToString Method

A string representation of this object.

Syntax

[Sansar.Script.Interface] public override string ToString ()
Returns
A string representation of this object.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0