LightManagerSupport

public abstract class LightManagerSupport
Base class for implementing custom light managers in .NET

Constructors

LightManagerSupport

#
Default constructor
protected LightManagerSupport()

Methods

DeleteLight

#Since v6.0
Delete light
public abstract bool DeleteLight(
doc,
Light
light,
bUndelete
)
If delete is successful, then return true, else return false

GetLights

#Since v6.0
Get all the lights that are associated to the light manager. The lights are added to the LightArray parameter passed to the GetLights method
public abstract void GetLights(
doc,
light_array
)

GetLightSolo

#Since v6.0
Returns the value of "ON_LIght::m_bOn" if the light is in solo storage, or false if not in solo storage (ie - this is the checkbox state on the light manager dialog)
public virtual bool GetLightSolo(
doc,
uuid_light
)
Returns true if the light is in solo storage, or false if not in solo storage

GroupLights

#Since v6.0
Creates a new group with the lights
public abstract void GroupLights(
doc,
light_array
)

LightDescription

#Since v6.0
Gets the string representation of the light description
public abstract string LightDescription(
doc,
ref Light
light
)
Returns the string representation of the light description

LightFromId

#Since v6.0
Get Rhino.Geometry.Light object associated to Guig uuid
public abstract bool LightFromId(
doc,
uuid,
ref Light
light
)

LightsInSoloStorage

#Since v6.0
Returns the number of lights in solo storage - any number other than 0 means "in solo mode"
public virtual int LightsInSoloStorage()
Returns the number of lights in solo storage - any number other than 0 means "in solo mode"

ModifyLight

#Since v6.0
Modify properties of the light
public abstract void ModifyLight(
doc,
Light
light
)

ObjectSerialNumberFromLight

#Since v6.0
Get the object serial number of the light
public abstract int ObjectSerialNumberFromLight(
doc,
ref Light
light
)

OnCustomLightEvent

#Since v6.0
Generates LightMangerSupportCustomEvent: light_added, light_deleted, light_undeleted, light_modified, light_sorted, The event triggers a Light table event that the rdk lightmanager listens too
public void OnCustomLightEvent()
Returns the string representation of the light description

OnEditLight

#Since v6.0
The default implementation of OnEditLight selects the lights and opens the Lights Properties page
public abstract bool OnEditLight(
doc,
light_array
)
Returns true if successful, else false

PluginId

#Since v6.0
The Guid of the plugin
public abstract Guid PluginId()
Returns the Guid of the plugin

RegisterLightManager

#Since v6.0
Find and register classes that derive from LightManagerSupport from the given plug-in.
public static void RegisterLightManager(
plugin
)

RegisterProviders

#Since v6.0
Find and register classes that derive from RealtimeDisplayMode from the given plug-in. The plug-in is found in the given assembly
public static void RegisterProviders(
assembly,
pluginId
)

RenderEngineId

#Since v6.0
The Guid of the render engine
public abstract Guid RenderEngineId()
Returns the Guid of the render engine that is associated with this light manager

SetLightSolo

#Since v6.0
First checks to see if we are in "solo mode" - which means that there are any lights that respond "true" to IsInSoloStorage. If in solo mode: If bSolo = true Sets this light on. If bSolo = false If this is the last light "on", forces all lights out of solo mode. If there are other lights on, turns this light off. If not in solo mode: If bSolo = true Forces all lights into solo storage and sets this light on. If bSolo = false This shouldn't happen. Will cause an ASSERT
public virtual bool SetLightSolo(
doc,
uuid_light,
bSolo
)
Returns true if action is successful

UnGroup

#Since v6.0
UnGroups the lights
public abstract void UnGroup(
doc,
light_array
)