Show / Hide Table of Contents

Class MyVoxelMaps

Inheritance
System.Object
MyVoxelMaps
Implements
IMyVoxelMaps
Namespace: Sandbox.Game.Entities
Assembly: Sandbox.Game.dll
Syntax
public class MyVoxelMaps : Object, IMyVoxelMaps

Constructors

MyVoxelMaps()

Declaration
public MyVoxelMaps()

Properties

Instances

Declaration
public DictionaryValuesReader<long, MyVoxelBase> Instances { get; }
Property Value
Type Description
DictionaryValuesReader<System.Int64, MyVoxelBase>

Methods

Add(MyVoxelBase)

Declaration
public void Add(MyVoxelBase voxelMap)
Parameters
Type Name Description
MyVoxelBase voxelMap

Clear()

Declaration
public void Clear()

DebugDraw(MyVoxelDebugDrawMode)

Declaration
public void DebugDraw(MyVoxelDebugDrawMode drawMode)
Parameters
Type Name Description
VRage.Game.Voxels.MyVoxelDebugDrawMode drawMode

Exist(MyVoxelBase)

Declaration
public bool Exist(MyVoxelBase voxelMap)
Parameters
Type Name Description
MyVoxelBase voxelMap
Returns
Type Description
System.Boolean

GetAllOverlappingWithSphere(ref BoundingSphereD)

Declaration
public List<MyVoxelBase> GetAllOverlappingWithSphere(ref BoundingSphereD sphere)
Parameters
Type Name Description
BoundingSphereD sphere
Returns
Type Description
System.Collections.Generic.List<MyVoxelBase>

GetAllOverlappingWithSphere(ref BoundingSphereD, List<MyVoxelBase>)

Declaration
public void GetAllOverlappingWithSphere(ref BoundingSphereD sphere, List<MyVoxelBase> voxels)
Parameters
Type Name Description
BoundingSphereD sphere
System.Collections.Generic.List<MyVoxelBase> voxels

GetCacheStats(out Int32, out Int32)

Declaration
public void GetCacheStats(out int cachedChuncks, out int pendingCachedChuncks)
Parameters
Type Name Description
System.Int32 cachedChuncks
System.Int32 pendingCachedChuncks

GetOverlappingWithSphere(ref BoundingSphereD)

Declaration
public MyVoxelBase GetOverlappingWithSphere(ref BoundingSphereD sphere)
Parameters
Type Name Description
BoundingSphereD sphere
Returns
Type Description
MyVoxelBase

GetVoxelMapsArray(Boolean)

Declaration
public Dictionary<string, byte[]> GetVoxelMapsArray(bool includeChanged)
Parameters
Type Name Description
System.Boolean includeChanged
Returns
Type Description
System.Collections.Generic.Dictionary<System.String, System.Byte[]>

GetVoxelMapsData(Boolean, Boolean, Dictionary<String, IMyStorage>)

Declaration
public Dictionary<string, byte[]> GetVoxelMapsData(bool includeChanged, bool compressed, Dictionary<string, IMyStorage> voxelStorageNameCache = null)
Parameters
Type Name Description
System.Boolean includeChanged
System.Boolean compressed
System.Collections.Generic.Dictionary<System.String, VRage.Game.Voxels.IMyStorage> voxelStorageNameCache
Returns
Type Description
System.Collections.Generic.Dictionary<System.String, System.Byte[]>

GetVoxelMapsWhoseBoundingBoxesIntersectBox(ref BoundingBoxD, MyVoxelBase, List<MyVoxelBase>)

Declaration
public bool GetVoxelMapsWhoseBoundingBoxesIntersectBox(ref BoundingBoxD boundingBox, MyVoxelBase ignoreVoxelMap, List<MyVoxelBase> voxelList)
Parameters
Type Name Description
BoundingBoxD boundingBox
MyVoxelBase ignoreVoxelMap
System.Collections.Generic.List<MyVoxelBase> voxelList
Returns
Type Description
System.Boolean

GetVoxelMapWhoseBoundingBoxIntersectsBox(ref BoundingBoxD, MyVoxelBase)

Return reference to voxel map that intersects the box. If not voxel map found, null is returned.

Declaration
public MyVoxelBase GetVoxelMapWhoseBoundingBoxIntersectsBox(ref BoundingBoxD boundingBox, MyVoxelBase ignoreVoxelMap)
Parameters
Type Name Description
BoundingBoxD boundingBox
MyVoxelBase ignoreVoxelMap
Returns
Type Description
MyVoxelBase

RemoveVoxelMap(MyVoxelBase)

Declaration
public void RemoveVoxelMap(MyVoxelBase voxelMap)
Parameters
Type Name Description
MyVoxelBase voxelMap

TryGetVoxelBaseById(Int64)

Declaration
public MyVoxelBase TryGetVoxelBaseById(long id)
Parameters
Type Name Description
System.Int64 id
Returns
Type Description
MyVoxelBase

TryGetVoxelMapByName(String)

Declaration
public MyVoxelBase TryGetVoxelMapByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
MyVoxelBase

TryGetVoxelMapByNameStart(String)

Declaration
public MyVoxelBase TryGetVoxelMapByNameStart(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
MyVoxelBase

Explicit Interface Implementations

IMyVoxelMaps.Clear()

Declaration
void IMyVoxelMaps.Clear()

IMyVoxelMaps.CreatePredefinedVoxelMap(String, String, MatrixD, Boolean)

Declaration
IMyVoxelMap IMyVoxelMaps.CreatePredefinedVoxelMap(string storageName, string voxelMaterial, MatrixD matrix, bool useVoxelOffset)
Parameters
Type Name Description
System.String storageName
System.String voxelMaterial
MatrixD matrix
System.Boolean useVoxelOffset
Returns
Type Description
IMyVoxelMap

IMyVoxelMaps.CreateProceduralVoxelMap(Int32, Single, MatrixD)

Declaration
IMyVoxelMap IMyVoxelMaps.CreateProceduralVoxelMap(int seed, float radius, MatrixD matrix)
Parameters
Type Name Description
System.Int32 seed
System.Single radius
MatrixD matrix
Returns
Type Description
IMyVoxelMap

IMyVoxelMaps.CreateStorage(Byte[])

Declaration
IMyStorage IMyVoxelMaps.CreateStorage(byte[] data)
Parameters
Type Name Description
System.Byte[] data
Returns
Type Description
IMyStorage

IMyVoxelMaps.CreateStorage(Vector3I)

Declaration
IMyStorage IMyVoxelMaps.CreateStorage(Vector3I size)
Parameters
Type Name Description
Vector3I size
Returns
Type Description
IMyStorage

IMyVoxelMaps.CreateVoxelMap(String, IMyStorage, Vector3D, Int64)

Declaration
IMyVoxelMap IMyVoxelMaps.CreateVoxelMap(string storageName, IMyStorage storage, Vector3D position, long voxelMapId)
Parameters
Type Name Description
System.String storageName
IMyStorage storage
Vector3D position
System.Int64 voxelMapId
Returns
Type Description
IMyVoxelMap

IMyVoxelMaps.CreateVoxelMapFromStorageName(String, String, Vector3D)

Declaration
IMyVoxelMap IMyVoxelMaps.CreateVoxelMapFromStorageName(string storageName, string prefabVoxelMapName, Vector3D position)
Parameters
Type Name Description
System.String storageName
System.String prefabVoxelMapName
Vector3D position
Returns
Type Description
IMyVoxelMap

IMyVoxelMaps.CutOutShape(IMyVoxelBase, IMyVoxelShape)

Declaration
void IMyVoxelMaps.CutOutShape(IMyVoxelBase voxelMap, IMyVoxelShape voxelShape)
Parameters
Type Name Description
IMyVoxelBase voxelMap
IMyVoxelShape voxelShape

IMyVoxelMaps.Exist(IMyVoxelBase)

Declaration
bool IMyVoxelMaps.Exist(IMyVoxelBase voxelMap)
Parameters
Type Name Description
IMyVoxelBase voxelMap
Returns
Type Description
System.Boolean

IMyVoxelMaps.FillInShape(IMyVoxelBase, IMyVoxelShape, Byte)

Declaration
void IMyVoxelMaps.FillInShape(IMyVoxelBase voxelMap, IMyVoxelShape voxelShape, byte materialIdx)
Parameters
Type Name Description
IMyVoxelBase voxelMap
IMyVoxelShape voxelShape
System.Byte materialIdx

IMyVoxelMaps.GetBoxVoxelHand()

Declaration
IMyVoxelShapeBox IMyVoxelMaps.GetBoxVoxelHand()
Returns
Type Description
IMyVoxelShapeBox

IMyVoxelMaps.GetCapsuleVoxelHand()

Declaration
IMyVoxelShapeCapsule IMyVoxelMaps.GetCapsuleVoxelHand()
Returns
Type Description
IMyVoxelShapeCapsule

IMyVoxelMaps.GetInstances(List<IMyVoxelBase>, Func<IMyVoxelBase, Boolean>)

Declaration
void IMyVoxelMaps.GetInstances(List<IMyVoxelBase> voxelMaps, Func<IMyVoxelBase, bool> collect)
Parameters
Type Name Description
System.Collections.Generic.List<IMyVoxelBase> voxelMaps
System.Func<IMyVoxelBase, System.Boolean> collect

IMyVoxelMaps.GetOverlappingWithSphere(ref BoundingSphereD)

Declaration
IMyVoxelBase IMyVoxelMaps.GetOverlappingWithSphere(ref BoundingSphereD sphere)
Parameters
Type Name Description
BoundingSphereD sphere
Returns
Type Description
IMyVoxelBase

IMyVoxelMaps.GetRampVoxelHand()

Declaration
IMyVoxelShapeRamp IMyVoxelMaps.GetRampVoxelHand()
Returns
Type Description
IMyVoxelShapeRamp

IMyVoxelMaps.GetSphereVoxelHand()

Declaration
IMyVoxelShapeSphere IMyVoxelMaps.GetSphereVoxelHand()
Returns
Type Description
IMyVoxelShapeSphere

IMyVoxelMaps.GetVoxelMapWhoseBoundingBoxIntersectsBox(ref BoundingBoxD, IMyVoxelBase)

Declaration
IMyVoxelBase IMyVoxelMaps.GetVoxelMapWhoseBoundingBoxIntersectsBox(ref BoundingBoxD boundingBox, IMyVoxelBase ignoreVoxelMap)
Parameters
Type Name Description
BoundingBoxD boundingBox
IMyVoxelBase ignoreVoxelMap
Returns
Type Description
IMyVoxelBase

IMyVoxelMaps.MakeCrater(IMyVoxelBase, BoundingSphereD, Vector3, Byte)

Declaration
void IMyVoxelMaps.MakeCrater(IMyVoxelBase voxelMap, BoundingSphereD sphere, Vector3 direction, byte materialIdx)
Parameters
Type Name Description
IMyVoxelBase voxelMap
BoundingSphereD sphere
Vector3 direction
System.Byte materialIdx

IMyVoxelMaps.PaintInShape(IMyVoxelBase, IMyVoxelShape, Byte)

Declaration
void IMyVoxelMaps.PaintInShape(IMyVoxelBase voxelMap, IMyVoxelShape voxelShape, byte materialIdx)
Parameters
Type Name Description
IMyVoxelBase voxelMap
IMyVoxelShape voxelShape
System.Byte materialIdx

IMyVoxelMaps.RevertShape(IMyVoxelBase, IMyVoxelShape)

Declaration
void IMyVoxelMaps.RevertShape(IMyVoxelBase voxelMap, IMyVoxelShape voxelShape)
Parameters
Type Name Description
IMyVoxelBase voxelMap
IMyVoxelShape voxelShape

IMyVoxelMaps.SpawnPlanet(String, Single, Int32, Vector3D)

Declaration
IMyVoxelBase IMyVoxelMaps.SpawnPlanet(string planetName, float size, int seed, Vector3D pos)
Parameters
Type Name Description
System.String planetName
System.Single size
System.Int32 seed
Vector3D pos
Returns
Type Description
IMyVoxelBase

IMyVoxelMaps.VoxelMaterialCount

Declaration
int IMyVoxelMaps.VoxelMaterialCount { get; }
Returns
Type Description
System.Int32

Implements

IMyVoxelMaps
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾