Visual3D Game Engine API Documentation for XNA, C#, VB, and .NET

Define a point in the scene. Can be bound to any SceneObject via TrackedObject, or positioned explicitly via StaticLocation property. May have optional text label and custom coloration of lead line, point and label.

Namespace: Visual3D
Assembly: Visual3D.Engine (in Visual3D.Engine.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax


	C#			Visual Basic

public class ScenePoint

Public Class ScenePoint

Members

All Members

Constructors Public method

Properties Public property

Methods

Events

 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

	Member	Description
	ScenePoint(Vector3)	Initializes a new instance of the ScenePoint class
	ScenePoint(SceneObject)	Initializes a new instance of the ScenePoint class
	ScenePoint(Vector3, String)	Initializes a new instance of the ScenePoint class
	ScenePoint(SceneObject, String)	Initializes a new instance of the ScenePoint class
	ScenePoint(Single, Single, Single)	Initializes a new instance of the ScenePoint class
	ScenePoint(Single, Single, Single, String)	Initializes a new instance of the ScenePoint class
	CurrentLocation	Gets a current location of waypoint in world units, depending on TrackedObject or StaticLocation property values. Uses StaticLocation if TrackedObject set to null.
	DotSignColor	Color of the dot sign drawn if ShowDotSign is set to true. Default is yellow.
	GhostBodyChanged
	GhostBodyModelName	Name of the semitransparent (ghost-like) model drawn near waypoint. Default is null value (no ghost model). See also GhostBodyRotation, GhostBodyScale and GhostBodyOffset properties for more controls over the ghost body.
	GhostBodyOffset	Positional offset in world units from the waypoint location for GhostBodyModel, if one is specified. Default is empty vector (no offset).
	GhostBodyRotation	Rotation for GhostBodyModel if one is specified. Default is Quaternion.Identity (no rotation).
	GhostBodyScale	Scale factor for GhostBodyModel if one is specified.
	HideVisualizers()()()()
	IndicatorChanged
	LabelColor	Color of text label drawn. See also LabelText and ShowLabel properties.
	LabelFontSize	Font size of text label drawn. See also LabelText and ShowLabel properties.
	LabelText	Gets/sets a string of text to draw nearby from the waypoint. See also ShowLabel property.
	LeadLineColor	Color of the lead line drawn under the text label if ShowLabel is set to true. Default is white.
	LocationChanged
	ShowDotSign	Enable or disable rendering of the dot sign (map point). Default is true (enabled). Visibility of the text label and ghost body is configured independently.
	ShowGhostBody	Enable or disable rendering of the semitransparent (ghost-like) model whose name is assigned via GhostBodyModelName property. Will return false if no ghost model is assigned to the waypoint. Default is true (enabled). Visibility of the dot sign and text label is configured independently.
	ShowLabel	Enable or disable rendering of the text label. Default is true (enabled). Visibility of the dot sign and ghost body is configured independently.
	ShowVisualizers()()()()
	StaticLocation	Gets/s
	ToString()()()()	(Overrides Object..::..ToString()()()().)
	TrackedObject	Gets/sets an object in scene which will be bound to the waypoint. For additional offset from the objetct location, use TrackedObjectOffset property.
	TrackedObjectOffset	Gets/sets optional offset from the TrackedObject's location to put waypoint to. Default is zero vector (no offset).

Inheritance Hierarchy

System..::..Object
Visual3D..::..ScenePoint

Syntax

Members

Inheritance Hierarchy

See Also