Inheritance diagram for Highlighting.Highlighter:

Public Member Functions
void	ConstantOff ()
	Fade out constant highlighting. More...

void	ConstantOffImmediate ()
	Turn off constant highlighting immediately (without fading out). More...

void	ConstantOn ()
	Fade in constant highlighting. More...

void	ConstantOn (Color color)
	Fade in constant highlighting with given color. More...

void	ConstantOnImmediate ()
	Turn on constant highlighting immediately (without fading in). More...

void	ConstantOnImmediate (Color color)
	Turn on constant highlighting with given color immediately (without fading in). More...

void	ConstantParams (Color color)
	Set constant highlighting color. More...

void	ConstantSwitch ()
	Switch Constant Highlighting. More...

void	ConstantSwitchImmediate ()
	Switch constant highlighting immediately (without fading in/out). More...

void	Die ()
	Destroy this Highlighter component. More...

void	FillBuffer (CommandBuffer buffer, int renderQueue)

void	FlashingOff ()
	Turn off flashing. More...

void	FlashingOn ()
	Turn on flashing. More...

void	FlashingOn (Color color1, Color color2)
	Turn on flashing from color1 to color2. More...

void	FlashingOn (Color color1, Color color2, float freq)
	Turn on flashing from color1 to color2 with given frequency. More...

void	FlashingOn (float freq)
	Turn on flashing with given frequency. More...

void	FlashingParams (Color color1, Color color2, float freq)
	Set flashing parameters. More...

void	FlashingSwitch ()
	Switch flashing mode. More...

void	OccluderOff ()
	Disable occluder mode. Non-see-through occluders will be used only in case frame depth buffer is not accessible. More...

void	OccluderOn ()
	Enable occluder mode. Non-see-through occluders will be used only in case frame depth buffer is not accessible. More...

void	OccluderSwitch ()
	Switch occluder mode. Non-see-through occluders will be used only in case frame depth buffer is not accessible. More...

void	Off ()
	Turn off all types of highlighting. More...

void	On ()
	Turn on one-frame highlighting. More...

void	On (Color color)
	Turn on one-frame highlighting with given color. Can be called multiple times per update, color only from the latest call will be used. More...

void	OnParams (Color color)
	Set color for one-frame highlighting mode. More...

void	ReinitMaterials ()
	Renderers reinitialization. Call this method if your highlighted object has changed it's materials, renderers or child objects. Can be called multiple times per update - renderers reinitialization will occur only once. More...

void	SeeThroughOff ()
	Disable see-through mode More...

void	SeeThroughOn ()
	Enable see-through mode More...

void	SeeThroughSwitch ()
	Switch see-through mode More...

bool	UpdateHighlighting (bool isDepthAvailable)

Static Public Member Functions
static HashSet< Highlighter > .Enumerator	GetEnumerator ()

static void	Initialize ()

static void	SetOffsetFactor (float value)

static void	SetOffsetUnits (float value)

static void	SetZWrite (float value)

Public Attributes
const int	highlightingLayer = 7
	Only these types of Renderers will be highlighted. More...

Static Public Attributes
static Color	colorConstructionPartDropAsNewVessel = new Color(0.7764706f, 0.3176471f, 0.007843138f, 1f)
	Colour used to highlight an a part about to be dropped In Flight(Construction) as a new vessel. More...

static Color	colorPartConstructionValid = new Color(0, 1, 0, 1)
	The color used to highlight parts when they can be constructed with More...

static Color	colorPartEditorActionHighlight = new Color(0, 1, 1, 1)
	The color indicating the highlighted part for action group editing More...

static Color	colorPartEditorActionSelected = new Color(0, 0, 1, 1)
	The color indicating the selected part for action group editing More...

static Color	colorPartEditorAttached = new Color(0, 1, 0, 1)
	The color used for when parts can be attached when placing in the editor More...

static Color	colorPartEditorAxisHighlight = new Color(0, 1, 1, 1)
	The color indicating the highlighted part for axis group editing More...

static Color	colorPartEditorAxisSelected = new Color(0, 0, 1, 1)
	The color indicating the selected part for axis group editing More...

static Color	colorPartEditorDetached = new Color(1, 0, 0, 1)
	The color used for when parts cannot be attached when placing in the editor More...

static Color	colorPartEngineerAppHighlight = new Color(1, 0, 0, 1)
	The color to highlight parts related to engineer tool issues More...

static Color	colorPartHighlightDefault = new Color(0,1,0,1)
	The color used to highlight parts when hovered over More...

static Color	colorPartInventoryContainer = new Color(0.254902f, 0.9921569f, 0.9960784f, 1f)
	Colour used to highlight an inventory part with unavailable inventory slots (space) when the user is holding a cargo part. More...

static Color	colorPartInventoryUnavailableSpace = Color.yellow
	Colour used to highlight an inventory part with unavailable inventory slots (space) when the user is holding a cargo part. More...

static Color	colorPartRootToolHighlight = new Color(0.03921569f, 0.5333334f, 0.5411765f, 0.3f)
	The color indicating the highlighted part for the reroot tool More...

static Color	colorPartRootToolHighlightEdge = new Color(0f, 1f, 1f, 0.5f)
	The color indicating the edge highlighting of the highlighted part for the reroot tool More...

static Color	colorPartRootToolHover = new Color(0.254902f, 0.9921569f, 0.9960784f, 1f)
	The color indicating the hovered part for the reroot tool More...

static Color	colorPartRootToolHoverEdge = new Color(0.04313726f, 0.9764706f, 0.9176471f, 1f)
	The color indicating the edge highlighting of the hovered part for the reroot tool More...

static Color	colorPartTransferDestHighlight = new Color(0.5490196f, 1f, 0.8588235f, 1f)
	The color indicating the destination part for the transfers More...

static Color	colorPartTransferDestHover = new Color(0.04313726f, 0.9764706f, 0.9176471f, 1f)
	The hover color indicating the destination part for the transfers More...

static Color	colorPartTransferSourceHighlight = new Color(0.7764706f, 0.3176471f, 0.007843138f, 1f)
	The color indicating the source part for the transfers More...

static Color	colorPartTransferSourceHover = new Color(1f, 0.694f, 0f, 1f)
	The hover color indicating the source part for the transfers More...

static float	HighlighterLimit = 1f

static readonly List< System.Type >	types

Properties
static int	_BackTex `[get, set]`

static int	_Cull `[get, set]`

static int	_Cutoff `[get, set]`

static int	_HighlightingBlur1 `[get, set]`

static int	_HighlightingBlur2 `[get, set]`

static int	_HighlightingBlurOffset `[get, set]`

static int	_HighlightingBlurred `[get, set]`

static int	_HighlightingBuffer `[get, set]`

static int	_HighlightingBufferTexelSize `[get, set]`

static int	_HighlightingOffsetFactor `[get, set]`

static int	_HighlightingOffsetUnits `[get, set]`

static int	_HighlightingZWrite `[get, set]`

static int	_Intensity `[get, set]`

static int	_MainTex `[get, set]`

static int	_Outline `[get, set]`

static int	_StencilRef `[get, set]`

static int	_ZTest `[get, set]`

static bool	HighlightDirty `[get, set]`

bool	highlighted `[get, set]`

static Shader	opaqueShader `[get]`

static Shader	transparentBackgroundShader `[get]`

static Shader	transparentShader `[get]`

Member Function Documentation

void Highlighting.Highlighter.ConstantOff ( )

inline

Fade out constant highlighting.

< Start transition

void Highlighting.Highlighter.ConstantOffImmediate ( )

inline

Turn off constant highlighting immediately (without fading out).

< Set transition value to 0

< Stop transition

void Highlighting.Highlighter.ConstantOn ( )

inline

Fade in constant highlighting.

< Start transition

void Highlighting.Highlighter.ConstantOn ( Color color )

inline

Fade in constant highlighting with given color.

Parameters

color Constant highlighting color.

void Highlighting.Highlighter.ConstantOnImmediate ( )

inline

Turn on constant highlighting immediately (without fading in).

< Set transition value to 1

< Stop transition

void Highlighting.Highlighter.ConstantOnImmediate ( Color color )

inline

Turn on constant highlighting with given color immediately (without fading in).

Parameters

color Constant highlighting color.

void Highlighting.Highlighter.ConstantParams ( Color color )

inline

Set constant highlighting color.

Parameters

color Constant highlighting color.

void Highlighting.Highlighter.ConstantSwitch ( )

inline

Switch Constant Highlighting.

< Start transition

void Highlighting.Highlighter.ConstantSwitchImmediate ( )

inline

Switch constant highlighting immediately (without fading in/out).

< Set transition value to the final value

< Stop transition

void Highlighting.Highlighter.Die ( )

inline

Destroy this Highlighter component.

void Highlighting.Highlighter.FillBuffer	(	CommandBuffer	buffer,
		int	renderQueue
	)

inline

void Highlighting.Highlighter.FlashingOff ( )

inline

Turn off flashing.

void Highlighting.Highlighter.FlashingOn ( )

inline

Turn on flashing.

void Highlighting.Highlighter.FlashingOn	(	Color	color1,
		Color	color2
	)

inline

Turn on flashing from color1 to color2.

Parameters

color1	Starting color.
color2	Ending color.

void Highlighting.Highlighter.FlashingOn	(	Color	color1,
		Color	color2,
		float	freq
	)

inline

Turn on flashing from color1 to color2 with given frequency.

Parameters

color1	Starting color.
color2	Ending color.
freq	Flashing frequency (times per second).

void Highlighting.Highlighter.FlashingOn ( float freq )

inline

Turn on flashing with given frequency.

Parameters

f	Flashing frequency (times per second).

void Highlighting.Highlighter.FlashingParams	(	Color	color1,
		Color	color2,
		float	freq
	)

inline

Set flashing parameters.

Parameters

color1	Starting color.
color2	Ending color.
freq	Flashing frequency (times per second).

void Highlighting.Highlighter.FlashingSwitch ( )

inline

Switch flashing mode.

static HashSet<Highlighter>.Enumerator Highlighting.Highlighter.GetEnumerator ( )

inlinestatic

static void Highlighting.Highlighter.Initialize ( )

inlinestatic

void Highlighting.Highlighter.OccluderOff ( )

inline

Disable occluder mode. Non-see-through occluders will be used only in case frame depth buffer is not accessible.

void Highlighting.Highlighter.OccluderOn ( )

inline

Enable occluder mode. Non-see-through occluders will be used only in case frame depth buffer is not accessible.

void Highlighting.Highlighter.OccluderSwitch ( )

inline

Switch occluder mode. Non-see-through occluders will be used only in case frame depth buffer is not accessible.

void Highlighting.Highlighter.Off ( )

inline

Turn off all types of highlighting.

< Set transition value to 0

< Stop transition

void Highlighting.Highlighter.On ( )

inline

Turn on one-frame highlighting.

void Highlighting.Highlighter.On ( Color color )

inline

Turn on one-frame highlighting with given color. Can be called multiple times per update, color only from the latest call will be used.

Parameters

color Highlighting color.

void Highlighting.Highlighter.OnParams ( Color color )

inline

Set color for one-frame highlighting mode.

Parameters

color Highlighting color.

void Highlighting.Highlighter.ReinitMaterials ( )

inline

Renderers reinitialization. Call this method if your highlighted object has changed it's materials, renderers or child objects. Can be called multiple times per update - renderers reinitialization will occur only once.

void Highlighting.Highlighter.SeeThroughOff ( )

inline

Disable see-through mode

void Highlighting.Highlighter.SeeThroughOn ( )

inline

Enable see-through mode

void Highlighting.Highlighter.SeeThroughSwitch ( )

inline

Switch see-through mode

static void Highlighting.Highlighter.SetOffsetFactor ( float value )

inlinestatic

static void Highlighting.Highlighter.SetOffsetUnits ( float value )

inlinestatic

static void Highlighting.Highlighter.SetZWrite ( float value )

inlinestatic

bool Highlighting.Highlighter.UpdateHighlighting ( bool isDepthAvailable )

inline

< Is any highlighting mode is enabled?

< Render as highlighter

< RenderQueue = (seeThrough ? Geometry+1 : Geometry)

< RenderQueue = (seeThrough ? Occluder queue : Geometry queue)

Member Data Documentation

Color Highlighting.Highlighter.colorConstructionPartDropAsNewVessel = new Color(0.7764706f, 0.3176471f, 0.007843138f, 1f)

static

Colour used to highlight an a part about to be dropped In Flight(Construction) as a new vessel.

Color Highlighting.Highlighter.colorPartConstructionValid = new Color(0, 1, 0, 1)

static

The color used to highlight parts when they can be constructed with

Color Highlighting.Highlighter.colorPartEditorActionHighlight = new Color(0, 1, 1, 1)

static

The color indicating the highlighted part for action group editing

Color Highlighting.Highlighter.colorPartEditorActionSelected = new Color(0, 0, 1, 1)

static

The color indicating the selected part for action group editing

Color Highlighting.Highlighter.colorPartEditorAttached = new Color(0, 1, 0, 1)

static

The color used for when parts can be attached when placing in the editor

Color Highlighting.Highlighter.colorPartEditorAxisHighlight = new Color(0, 1, 1, 1)

static

The color indicating the highlighted part for axis group editing

Color Highlighting.Highlighter.colorPartEditorAxisSelected = new Color(0, 0, 1, 1)

static

The color indicating the selected part for axis group editing

Color Highlighting.Highlighter.colorPartEditorDetached = new Color(1, 0, 0, 1)

static

The color used for when parts cannot be attached when placing in the editor

Color Highlighting.Highlighter.colorPartEngineerAppHighlight = new Color(1, 0, 0, 1)

static

The color to highlight parts related to engineer tool issues

Color Highlighting.Highlighter.colorPartHighlightDefault = new Color(0,1,0,1)

static

The color used to highlight parts when hovered over

Color Highlighting.Highlighter.colorPartInventoryContainer = new Color(0.254902f, 0.9921569f, 0.9960784f, 1f)

static

Colour used to highlight an inventory part with unavailable inventory slots (space) when the user is holding a cargo part.

Color Highlighting.Highlighter.colorPartInventoryUnavailableSpace = Color.yellow

static

Colour used to highlight an inventory part with unavailable inventory slots (space) when the user is holding a cargo part.

Color Highlighting.Highlighter.colorPartRootToolHighlight = new Color(0.03921569f, 0.5333334f, 0.5411765f, 0.3f)

static

The color indicating the highlighted part for the reroot tool

Color Highlighting.Highlighter.colorPartRootToolHighlightEdge = new Color(0f, 1f, 1f, 0.5f)

static

The color indicating the edge highlighting of the highlighted part for the reroot tool

Color Highlighting.Highlighter.colorPartRootToolHover = new Color(0.254902f, 0.9921569f, 0.9960784f, 1f)

static

The color indicating the hovered part for the reroot tool

Color Highlighting.Highlighter.colorPartRootToolHoverEdge = new Color(0.04313726f, 0.9764706f, 0.9176471f, 1f)

static

The color indicating the edge highlighting of the hovered part for the reroot tool

Color Highlighting.Highlighter.colorPartTransferDestHighlight = new Color(0.5490196f, 1f, 0.8588235f, 1f)

static

The color indicating the destination part for the transfers

Color Highlighting.Highlighter.colorPartTransferDestHover = new Color(0.04313726f, 0.9764706f, 0.9176471f, 1f)

static

The hover color indicating the destination part for the transfers

Color Highlighting.Highlighter.colorPartTransferSourceHighlight = new Color(0.7764706f, 0.3176471f, 0.007843138f, 1f)

static

The color indicating the source part for the transfers

Color Highlighting.Highlighter.colorPartTransferSourceHover = new Color(1f, 0.694f, 0f, 1f)

static

The hover color indicating the source part for the transfers

float Highlighting.Highlighter.HighlighterLimit = 1f

static

const int Highlighting.Highlighter.highlightingLayer = 7

Only these types of Renderers will be highlighted.

readonly List<System.Type> Highlighting.Highlighter.types

static

Initial value:

= new List<System.Type>()
        {
            typeof(MeshRenderer),
            typeof(SkinnedMeshRenderer)
        }

Property Documentation

int Highlighting.Highlighter._BackTex

staticgetset

int Highlighting.Highlighter._Cull

staticgetset

int Highlighting.Highlighter._Cutoff

staticgetset

int Highlighting.Highlighter._HighlightingBlur1

staticgetset

int Highlighting.Highlighter._HighlightingBlur2

staticgetset

int Highlighting.Highlighter._HighlightingBlurOffset

staticgetset

int Highlighting.Highlighter._HighlightingBlurred

staticgetset

int Highlighting.Highlighter._HighlightingBuffer

staticgetset

int Highlighting.Highlighter._HighlightingBufferTexelSize

staticgetset

int Highlighting.Highlighter._HighlightingOffsetFactor

staticgetset

int Highlighting.Highlighter._HighlightingOffsetUnits

staticgetset

int Highlighting.Highlighter._HighlightingZWrite

staticgetset

int Highlighting.Highlighter._Intensity

staticgetset

int Highlighting.Highlighter._MainTex

staticgetset

int Highlighting.Highlighter._Outline

staticgetset

int Highlighting.Highlighter._StencilRef

staticgetset

int Highlighting.Highlighter._ZTest

staticgetset

bool Highlighting.Highlighter.HighlightDirty

staticgetset

bool Highlighting.Highlighter.highlighted

getset

Shader Highlighting.Highlighter.opaqueShader

staticget

Shader Highlighting.Highlighter.transparentBackgroundShader

staticget

Shader Highlighting.Highlighter.transparentShader

staticget

The documentation for this class was generated from the following file:

KSP/Assets/Packages/HighlightingSystem/Highlighter.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Member Function Documentation

Member Data Documentation

Property Documentation