InstancedTextNode Class


InstancedTextNode Class

[Missing <summary> documentation for "T:Ab4d.SharpEngine.SceneNodes.InstancedTextNode"]

Inheritance Hierarchy

SystemObject
  Ab4d.SharpEngine.CoreComponentBase
    Ab4d.SharpEngine.CoreInitializedSceneComponent
      Ab4d.SharpEngine.SceneNodesSceneNode
        Ab4d.SharpEngine.SceneNodesRenderedNode
          Ab4d.SharpEngine.SceneNodesInstancedTextNode

Namespace: Ab4d.SharpEngine.SceneNodes
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.1.9316+94bbd23b55747f096f056a5602f7dd90558b3673

Syntax

Copy

public class InstancedTextNode : RenderedNode, 
	IInstancedNode

The InstancedTextNode type exposes the following members.

Constructors

	Name	Description
	InstancedTextNode(BitmapFont, IBitmapIO, String)	Constructor
	InstancedTextNode(BitmapFont, Boolean, IBitmapIO, String)	Constructor
	InstancedTextNode(BitmapFont, Vector3, Vector3, IBitmapIO, String)	Constructor
	InstancedTextNode(BitmapFont, Boolean, Vector3, Vector3, IBitmapIO, String)	Constructor

Top

Properties

	Name	Description
	AdditionalCharacterSpace	Gets or sets additional space after each character.
	AdditionalLineSpace	Gets or sets additional space after each line.
	AlphaClipThreshold	AlphaClipThreshold is used to correctly render the textures with rendered characters and transparent background. It specifies at which alpha value the pixels will be clipped (not rendered and their depth will not be written to the depth buffer). Default value is 0.5. When set to 0, then alpha-clipping is disabled and in this case the characters may not be rendered correctly.
	CacheFontGpuImages	When true (by default) than loaded font GpuImages are cached on the VulkanDevice's cache.
	CharactersCount	Gets the number of characters rendered by this InstancedTextNode.
	FontFamily	Gets the FontFamily that is used by this InstancedTextNode
	IsKerningUsed	Gets or sets a Boolean that specifies if font kerning is used (different distance between characters may be used based on the two characters).
	IsSolidColorMaterial	Gets or sets a Boolean that specifies if text is rendered with a solid color (without any shading based on lighting calculations). Default value is true.
	UnknownChar	Gets or sets a character that is displayed in case the character in the specified text is not defined in the bitmap font. By default, the UnknownChar is set to space. When UnknownChar is set to null char ('\0') that means that the unknown character is skipped (current position is not changed).

Top

Methods

	Name	Description
	AddText	Add the specified text to the InstancedTextNode with using simple position and size parameters. The orientation of the text is defined by the SetTextDirection(Vector3, Vector3) method.
	CollectRenderingItems	CollectRenderingItems (Overrides SceneNodeCollectRenderingItems(RenderingContext))
	Dispose	Dispose (Overrides SceneNodeDispose(Boolean))
	GetCenterPosition	Returns center position of this RenderedNode. Center position is calculated from the center position of the local bounding box. (Overrides RenderedNodeGetCenterPosition(Boolean, Boolean))
	GetReport	Gets a string with a report that provides information which characters are used in this InstanceTextNode.
	OnInitializeSceneResources	Initializes resources with the specified Scene and GpuDevice. This method can be overriden and is called from InitializeSceneResources(Scene) method. (Overrides InitializedSceneComponentOnInitializeSceneResources(Scene, VulkanDevice))
	OnIsVisibleChanged	OnIsVisibleChanged is called when the value of IsVisible property is changed. Overridden implementations should update the IsVisible property of the RenderingItem objects that were already added to RenderingLayers. (Overrides SceneNodeOnIsVisibleChanged(Boolean))
	OnUpdate	OnUpdate (Overrides SceneNodeOnUpdate)
	OnWorldMatrixChanged	OnWorldMatrixChanged (Overrides SceneNodeOnWorldMatrixChanged)
	RemoveAllTexts	Removes all added texts from this InstancedTextNode.
	RemoveText	RemoveText removes the specified instancedText from this InstancedTextNode
	SetTextDirection	Sets the direction and orientation of the text that is added by AddText(String, Color4, Vector3, Single, Boolean). By default, the textDirection is set to (1, 0, 0) and upDirection is set to (0, 1, 0)
	UpdateLocalBoundingBox	UpdateLocalBoundingBox (Overrides SceneNodeUpdateLocalBoundingBox)

Top

Remarks

[Missing <remarks> documentation for "T:Ab4d.SharpEngine.SceneNodes.InstancedTextNode"]

Reference

Ab4d.SharpEngine.SceneNodes Namespace