3rd Eye Scene C#
3rd Eye Scene C# documentation
Tes::Handlers::ShapeComponent Class Reference

A minimalist MonoBehaviour used to track information about objects generated by Tes shape handlers. More...

List of all members.

Public Member Functions

bool TestFlag (ObjectFlag flag)
 Test flag in ObjectFlags.
void AddFlag (ObjectFlag flag)
 Set flag in ObjectFlags.
void ClearFlag (ObjectFlag flag)
 Clear flag in ObjectFlags.
void SetFlag (ObjectFlag flag, bool set)
 Set or clear flag in ObjectFlags.

Static Public Member Functions

static Color32 ConvertColour (uint colour)
 Translates a 3es colour to a native, Unity colour.
static uint ConvertColour (Color32 colour)
 Translates a Unity colour to a 3es colour value.

Properties

uint ObjectID [get, set]
 Object ID, unique in its shape handler.
ushort Category [get, set]
 Object's filtering category.
ushort ObjectFlags [get, set]
 ObjectFlag
Color32 Colour [get, set]
 Object colour.
int ExtendedValue [get, set]
 An extension value which can be used contextually by various shape types.
bool Dirty [get, set]
 May be used to flag a dirty status.
bool IsTransient [get]
 Is this a transient object (zero ObjectID).
bool Wireframe [get, set]
 Is ObjectFlag.Wireframe set?
bool Transparent [get, set]
 Is ObjectFlag.Transparent set?
bool TwoSided [get, set]
 Is ObjectFlag.TwoSided set?

Detailed Description

A minimalist MonoBehaviour used to track information about objects generated by Tes shape handlers.

For example, tracks wireframe/solid state.


Member Function Documentation

void Tes::Handlers::ShapeComponent::AddFlag ( ObjectFlag  flag) [inline]

Set flag in ObjectFlags.

Parameters:
flagThe flag to set.
void Tes::Handlers::ShapeComponent::ClearFlag ( ObjectFlag  flag) [inline]

Clear flag in ObjectFlags.

Parameters:
flagThe flag to clear.
static Color32 Tes::Handlers::ShapeComponent::ConvertColour ( uint  colour) [inline, static]

Translates a 3es colour to a native, Unity colour.

Parameters:
colourThe 3es colour to translate.
Returns:
The unity Color32 value for colour .
static uint Tes::Handlers::ShapeComponent::ConvertColour ( Color32  colour) [inline, static]

Translates a Unity colour to a 3es colour value.

Parameters:
colourThe Unity colour to translate.
Returns:
The 3es colour value for colour .
void Tes::Handlers::ShapeComponent::SetFlag ( ObjectFlag  flag,
bool  set 
) [inline]

Set or clear flag in ObjectFlags.

Parameters:
flagThe flag to set or clear.
setTrue to set, false to clear.
bool Tes::Handlers::ShapeComponent::TestFlag ( ObjectFlag  flag) [inline]

Test flag in ObjectFlags.

Parameters:
flagThe flag to test.
Returns:
True if the flag is set.

Property Documentation

bool Tes::Handlers::ShapeComponent::Dirty [get, set]

May be used to flag a dirty status.

Specific to the owning shape handler.

ushort Tes::Handlers::ShapeComponent::ObjectFlags [get, set]

ObjectFlag

uint Tes::Handlers::ShapeComponent::ObjectID [get, set]

Object ID, unique in its shape handler.

Zero for transient objects.

bool Tes::Handlers::ShapeComponent::Transparent [get, set]

Is ObjectFlag.Transparent set?

bool Tes::Handlers::ShapeComponent::TwoSided [get, set]

Is ObjectFlag.TwoSided set?

bool Tes::Handlers::ShapeComponent::Wireframe [get, set]

Is ObjectFlag.Wireframe set?


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations Properties Events