CircleModelNode Class


CircleModelNode Class

A flat 2D circle object in the 3D space.

Inheritance Hierarchy

SystemObject
  Ab4d.SharpEngine.CoreComponentBase
    Ab4d.SharpEngine.CoreInitializedSceneComponent
      Ab4d.SharpEngine.SceneNodesSceneNode
        Ab4d.SharpEngine.SceneNodesRenderedNode
          Ab4d.SharpEngine.SceneNodesModelNode
            Ab4d.SharpEngine.SceneNodesCircleModelNode

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

Syntax

Copy

public class CircleModelNode : ModelNode

The CircleModelNode type exposes the following members.

Constructors

	Name	Description
	CircleModelNode	Create a flat 2D circle.
	CircleModelNode(String)	Create a flat 2D circle.
	CircleModelNode(Material, String)	Create a flat 2D circle.
	CircleModelNode(Vector3, Vector3, Vector3, Single, Int32, String)	Create a flat 2D circle.
	CircleModelNode(Vector3, Vector3, Vector3, Single, Int32, Material, String)	Create a flat 2D circle with specified material.

Top

Properties

	Name	Description
	CenterPosition	Position of the circle's center. Property change will re-generate the mesh in the next update phase. To immediately re-generate the mesh, call the Update method.
	HeightScaleFactor	HeightScaleFactor can be used to produce an ellipse by scaling the height dimension of the circle. Default value is 1 that produces a circle. Property change will re-generate the mesh in the next update phase. To immediately re-generate the mesh, call the Update method.
	InnerRadius	Inner radius of the circle. When this value is bigger than zero, then the center of the circle is hollow until the InnerRadius. If InnerRadius is bigger then Radius, then it is used as Radius and Radius is used as InnerRadius. Default value is 0. Property change will re-generate the mesh in the next update phase. To immediately re-generate the mesh, call the Update method.
	Normal	Direction of the normal vector (perpendicular to circle's surface). Default value is (0, 0, 1). Property change will re-generate the mesh in the next update phase. To immediately re-generate the mesh, call the Update method.
	Radius	Radius of the circle. Property change will re-generate the mesh in the next update phase. To immediately re-generate the mesh, call the Update method.
	Segments	Number of segments/points comprising the circle's edge. Property change will re-generate the mesh in the next update phase. To immediately re-generate the mesh, call the Update method.
	StartAngle	Gets or sets the start angle in degrees that specified the start angle of the first position. This is useful for meshes with low segments count. For example, when segments count is 4, the angle may be set to 45 to get a rectangle that is aligned with axes. Default value is 0 (starts at x=0 and y=radius). Property change will re-generate the mesh in the next update phase. To immediately re-generate the mesh, call the Update method.
	TextureMappingType	Defines how the texture coordinates are defined for this circle. Default value is Rectangular. Property change will re-generate the mesh in the next update phase. To immediately re-generate the mesh, call the Update method.
	UpDirection	Direction of vector along the circle's surface (the up vector of the 2D shape). Default value is (0, 1, 0). Property change will re-generate the mesh in the next update phase. To immediately re-generate the mesh, call the Update method.

Top

Methods

	Name	Description
	CreateRectangle(Vector3, Vector2, Single)	CreateRectangle sets the properties of this CircleModelNode so that it renders a rectangle (Segments is set to 4 and StartAngle to 45) with the specified width and height (size) and direction. When innerSizeFactor is between 0 and 1, then center is hollow because InnerRadius is set. This method also calls the Update method that updates the mesh.
	CreateRectangle(Vector3, PositionTypes, Vector2, Single, Vector3, Vector3)	CreateRectangle sets the properties of this CircleModelNode so that it renders a rectangle (Segments is set to 4 and StartAngle to 45) with the specified width and height (size) and direction. When innerSizeFactor is between 0 and 1, then center is hollow because InnerRadius is set. This method also calls the Update method that updates the mesh.
	UpdateMesh	UpdateMesh method recreates the mesh based on the current object properties. The method should be overriden in the derived class that provides its own mesh generation. (Overrides ModelNodeUpdateMesh)

Top

Remarks

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

Reference

Ab4d.SharpEngine.SceneNodes Namespace