ModelColorLineEffect Class


ModelColorLineEffect Class

ModelColorLineEffect is an effect that is similar to ThickLineEffect but instead rendering lines with fixed and predefined color the line color is based on the color of the model that the line is created for.

Inheritance Hierarchy

SystemObject
  Ab3d.DirectXDXResourceBase
    Ab3d.DirectXSharedDXResource
      Ab3d.DirectXSharedDXDeviceResource
        Ab3d.DirectXEffect
          Ab3d.DirectX.EffectsThickLineEffect
            Ab3d.DirectX.EffectsModelColorLineEffect

Namespace: Ab3d.DirectX.Effects
Assembly: Ab3d.DXEngine (in Ab3d.DXEngine.dll) Version: 7.0.8865.1045

Syntax

Copy

public class ModelColorLineEffect : ThickLineEffect

The ModelColorLineEffect type exposes the following members.

Constructors

	Name	Description
	ModelColorLineEffect	Constructor

Top

Properties

	Name	Description
	DefaultLineColor	Color of the line that is used when the color cannot be determined from WPF material
	DepthBias	Gets or sets a float that specifies a bias that is used when doing a depth test. A bias is a value that is added to the line's depth value and can provide a small offset from another object to prevent Z-fighting that occurs when two objects have almost the same depth values.
	DynamicDepthBiasFactor	When DynamicDepthBiasFactor is bigger then 0 then this factor is multiplied by the distance of the position to the camera and this is then multiplied by the DepthBias. This can be used to correctly set the depth bias for objects that are close (require small depth bias) to the camera and to the objects that are far away from the camera (require big depth bias). A recommended value is 0.02. This works well for all distances of 3D objects when the DepthBias is set to 0.1.
	LinePattern	Gets or sets the 16 bit int value that defines the line pattern - if bit is 1 then line is drawn, when 0 line is not drawn. For example value 0xFFFF means full line without any dots or dashes. Value 0x5555 means line with dots - one full dot follows one empty dot. Default value is 0xFFFF which means that no pattern will be drawn.
	LinePatternOffset	Gets or sets a pattern offset. This value is usually between 0 and 1 - 0 value means no offset, 1 means offset for the whole patter which is the same as no offset. Value 0.1 means that the line will begin with the pattern advanced by 10%. Default value is 0.
	LinePatternScale	Gets or sets the pattern scale factor. Value 1 does not scale the pattern. Values bigger then 1 increase the pattern length; values smaller then 1 decrease the pattern length (making it more dense). Default value is 1.
	LineThickness	Gets or sets the thickness of the line in screen space units.
	ReadZBuffer	Gets or sets a Boolean that specifies if Z buffer is read when rendering the line - if the depth test is done when rendering the line. If false then the line is rendered regardless of its depth - if is rendered even if it is behind some other 3D objects.
	UseIndividualLineSettings	Gets or sets a Boolean that specifies if line setting (thickness, pattern, dept settings) are read from lines object. When false, then the line settings from this effect are used. Default value is true.
	UseIndividualModelColor	Gets or sets a Boolean that specifies if line color is set from model's color. When false, then the color for all lines is specified by the DefaultLineColor property. Default value is true.
	WriteZBuffer	Gets or sets a Boolean that specifies if Z buffer is written when rendering the line - if the line can occlude other 3D objects. If true then the objects behind the line will not be rendered. If false the line will not prevent rendering objects behind it.

Top

Methods

	Name	Description
	ApplyMaterial	Applies the material and object's world matrix to this effect. (Overrides ThickLineEffectApplyMaterial(Material, RenderablePrimitiveBase))

Top

Fields

	Name	Description
	EffectName	Effect name

Top

Reference

Ab3d.DirectX.Effects Namespace