Show / Hide Table of Contents

Class MyRenderComponentBase

Inheritance
System.Object
MyComponentBase
MyEntityComponentBase
MyRenderComponentBase
MyRenderComponent
MyNullRenderComponent
Inherited Members
MyEntityComponentBase.OnAddedToContainer()
MyEntityComponentBase.OnBeforeRemovedFromContainer()
MyEntityComponentBase.Container
MyEntityComponentBase.Entity
MyEntityComponentBase.AttachSyncToEntity
MyEntityComponentBase.OnAfterAddedToContainer
MyEntityComponentBase.BeforeRemovedFromContainer
MyComponentBase.SetContainer(IMyComponentContainer)
MyComponentBase.GetAs<T>()
MyComponentBase.OnAddedToScene()
MyComponentBase.OnRemovedFromScene()
MyComponentBase.Serialize(Boolean)
MyComponentBase.Deserialize(MyObjectBuilder_ComponentBase)
MyComponentBase.Init(MyComponentDefinitionBase)
MyComponentBase.IsSerialized()
MyComponentBase.RemoveExistingComponentOnNewInsert
MyComponentBase.ContainerBase
Namespace: VRage.Game.Components
Assembly: VRage.Game.dll
Syntax
public abstract class MyRenderComponentBase : MyEntityComponentBase, IMyEntityComponentBase, IMyComponentBase

Constructors

MyRenderComponentBase()

Declaration
protected MyRenderComponentBase()

Fields

DepthBias

Declaration
public byte DepthBias
Field Value
Type Description
System.Byte

FadeIn

Declaration
public bool FadeIn
Field Value
Type Description
System.Boolean

FadeOut

Declaration
public bool FadeOut
Field Value
Type Description
System.Boolean

LastMomentUpdateIndex

Declaration
public int LastMomentUpdateIndex
Field Value
Type Description
System.Int32

m_colorMaskHsv

Declaration
protected Vector3 m_colorMaskHsv
Field Value
Type Description
Vector3

m_diffuseColor

Declaration
protected Color m_diffuseColor
Field Value
Type Description
Color

m_enableColorMaskHsv

Declaration
protected bool m_enableColorMaskHsv
Field Value
Type Description
System.Boolean

m_parentIDs

Declaration
protected uint[] m_parentIDs
Field Value
Type Description
System.UInt32[]

m_renderObjectIDs

Declaration
protected uint[] m_renderObjectIDs
Field Value
Type Description
System.UInt32[]

m_textureChanges

Declaration
protected Dictionary<MyStringId, MyTextureChange> m_textureChanges
Field Value
Type Description
System.Collections.Generic.Dictionary<MyStringId, VRageRender.Messages.MyTextureChange>

NeedForDrawFromParentChanged

Declaration
public Action NeedForDrawFromParentChanged
Field Value
Type Description
System.Action

OldBlackToHSV

Declaration
public static readonly Vector3 OldBlackToHSV
Field Value
Type Description
Vector3

OldBlueToHSV

Declaration
public static readonly Vector3 OldBlueToHSV
Field Value
Type Description
Vector3

OldGrayToHSV

Declaration
public static readonly Vector3 OldGrayToHSV
Field Value
Type Description
Vector3

OldGreenToHSV

Declaration
public static readonly Vector3 OldGreenToHSV
Field Value
Type Description
Vector3

OldRedToHSV

Declaration
public static readonly Vector3 OldRedToHSV
Field Value
Type Description
Vector3

OldWhiteToHSV

Declaration
public static readonly Vector3 OldWhiteToHSV
Field Value
Type Description
Vector3

OldYellowToHSV

Declaration
public static readonly Vector3 OldYellowToHSV
Field Value
Type Description
Vector3

Transparency

Declaration
public float Transparency
Field Value
Type Description
System.Single

UNINITIALIZED_IDs

Declaration
public static uint[] UNINITIALIZED_IDs
Field Value
Type Description
System.UInt32[]

Properties

CastShadows

Declaration
public bool CastShadows { get; set; }
Property Value
Type Description
System.Boolean

ColorMaskHsv

Declaration
public Vector3 ColorMaskHsv { get; set; }
Property Value
Type Description
Vector3

ComponentTypeDebugString

Declaration
public override string ComponentTypeDebugString { get; }
Property Value
Type Description
System.String
Overrides
MyEntityComponentBase.ComponentTypeDebugString

DrawInAllCascades

Declaration
public bool DrawInAllCascades { get; set; }
Property Value
Type Description
System.Boolean

DrawOutsideViewDistance

Declaration
public bool DrawOutsideViewDistance { get; set; }
Property Value
Type Description
System.Boolean

EnableColorMaskHsv

Declaration
public bool EnableColorMaskHsv { get; set; }
Property Value
Type Description
System.Boolean

FastCastShadowResolve

Declaration
public bool FastCastShadowResolve { get; set; }
Property Value
Type Description
System.Boolean

MetalnessColorable

Declaration
public bool MetalnessColorable { get; set; }
Property Value
Type Description
System.Boolean

ModelStorage

Used by game to store model here. In game this is always of type MyModel. Implementation should only store and return passed object.

Declaration
public abstract object ModelStorage { get; set; }
Property Value
Type Description
System.Object

NearFlag

Declaration
public virtual bool NearFlag { get; set; }
Property Value
Type Description
System.Boolean

NeedsDraw

Declaration
public virtual bool NeedsDraw { get; set; }
Property Value
Type Description
System.Boolean

NeedsDrawFromParent

Declaration
public bool NeedsDrawFromParent { get; set; }
Property Value
Type Description
System.Boolean

NeedsResolveCastShadow

Declaration
public bool NeedsResolveCastShadow { get; set; }
Property Value
Type Description
System.Boolean

OffsetInVertexShader

Declaration
public bool OffsetInVertexShader { get; set; }
Property Value
Type Description
System.Boolean

ParentIDs

Declaration
public uint[] ParentIDs { get; }
Property Value
Type Description
System.UInt32[]

PersistentFlags

Declaration
public MyPersistentEntityFlags2 PersistentFlags { get; set; }
Property Value
Type Description
MyPersistentEntityFlags2

RenderObjectIDs

Declaration
public uint[] RenderObjectIDs { get; }
Property Value
Type Description
System.UInt32[]

ShadowBoxLod

Declaration
public bool ShadowBoxLod { get; set; }
Property Value
Type Description
System.Boolean

SkipIfTooSmall

Declaration
public bool SkipIfTooSmall { get; set; }
Property Value
Type Description
System.Boolean

TextureChanges

Declaration
public Dictionary<MyStringId, MyTextureChange> TextureChanges { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<MyStringId, VRageRender.Messages.MyTextureChange>

Visible

Declaration
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean

Methods

AddRenderObjects()

Declaration
public abstract void AddRenderObjects()

CanBeAddedToRender()

Declaration
protected virtual bool CanBeAddedToRender()
Returns
Type Description
System.Boolean

Draw()

Declaration
public abstract void Draw()

GetDiffuseColor()

Declaration
public Color GetDiffuseColor()
Returns
Type Description
Color

GetRenderCullingOptions()

Declaration
public virtual CullingOptions GetRenderCullingOptions()
Returns
Type Description
VRageRender.CullingOptions

GetRenderFlags()

Declaration
public virtual RenderFlags GetRenderFlags()
Returns
Type Description
VRageRender.RenderFlags

GetRenderObjectID()

Declaration
public uint GetRenderObjectID()
Returns
Type Description
System.UInt32

InvalidateRenderObjects()

Declaration
public virtual void InvalidateRenderObjects()

IsChild(Int32)

Declaration
public bool IsChild(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
System.Boolean

IsRenderObjectAssigned(Int32)

Declaration
public bool IsRenderObjectAssigned(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
System.Boolean

IsVisible()

Declaration
public abstract bool IsVisible()
Returns
Type Description
System.Boolean

PropagateVisibilityUpdates(Boolean)

Declaration
protected void PropagateVisibilityUpdates(bool always = false)
Parameters
Type Name Description
System.Boolean always

ReleaseRenderObjectID(Int32)

Declaration
public abstract void ReleaseRenderObjectID(int index)
Parameters
Type Name Description
System.Int32 index

RemoveRenderObjects()

Declaration
public virtual void RemoveRenderObjects()

ResizeRenderObjectArray(Int32)

Declaration
public void ResizeRenderObjectArray(int newSize)
Parameters
Type Name Description
System.Int32 newSize

SetParent(Int32, UInt32, Nullable<Matrix>)

Declaration
public void SetParent(int index, uint cellParentCullObject, Nullable<Matrix> childToParent = null)
Parameters
Type Name Description
System.Int32 index
System.UInt32 cellParentCullObject
System.Nullable<Matrix> childToParent

SetRenderObjectID(Int32, UInt32)

Declaration
public abstract void SetRenderObjectID(int index, uint ID)
Parameters
Type Name Description
System.Int32 index
System.UInt32 ID

SetVisibilityUpdates(Boolean)

Declaration
public void SetVisibilityUpdates(bool state)
Parameters
Type Name Description
System.Boolean state

UpdateRenderEntity(Vector3)

Declaration
public virtual void UpdateRenderEntity(Vector3 colorMaskHSV)
Parameters
Type Name Description
Vector3 colorMaskHSV

UpdateRenderObject(Boolean, Boolean)

Declaration
public void UpdateRenderObject(bool visible, bool updateChildren = true)
Parameters
Type Name Description
System.Boolean visible
System.Boolean updateChildren

UpdateRenderObjectLocal(Matrix)

Declaration
public void UpdateRenderObjectLocal(Matrix renderLocalMatrix)
Parameters
Type Name Description
Matrix renderLocalMatrix

UpdateRenderObjectVisibility(Boolean)

Declaration
protected virtual void UpdateRenderObjectVisibility(bool visible)
Parameters
Type Name Description
System.Boolean visible

UpdateRenderTextureChanges(Dictionary<MyStringId, MyTextureChange>)

Declaration
public virtual void UpdateRenderTextureChanges(Dictionary<MyStringId, MyTextureChange> skinTextureChanges)
Parameters
Type Name Description
System.Collections.Generic.Dictionary<MyStringId, VRageRender.Messages.MyTextureChange> skinTextureChanges

UpdateTransparency()

Declaration
public void UpdateTransparency()

Extension Methods

MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)
MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)
MyEntityContainerEventExtensions.UnregisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash)
MyEntityContainerEventExtensions.RaiseEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventParams)
MyRenderComponentBaseExtensions.GetModel(MyRenderComponentBase)
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾