C# Class Axiom.Core.SpecialCaseRenderQueue

Show file Open project: WolfgangSt/axiom

Public Methods

Method	Description
AddRenderQueue ( RenderQueueGroupID queueId ) : void	Adds an item to the 'special case' render queue list. Normally all render queues are rendered, in their usual sequence, only varying if a RenderQueueListener nominates for the queue to be repeated or skipped. This method allows you to add a render queue to a 'special case' list, which varies the behaviour. The effect of this list depends on the 'mode' in which this list is in, which might be to exclude these render queues, or to include them alone (excluding all other queues). This allows you to perform broad selective rendering without requiring a RenderQueueListener.
ClearRenderQueues ( ) : void	Clears the 'special case' render queue list.
IsRenderQueueToBeProcessed ( RenderQueueGroupID queueId ) : bool	Returns whether or not the named queue will be rendered based on the current 'special case' render queue list and mode.
RemoveRenderQueue ( RenderQueueGroupID queueId ) : void	Removes an item to the 'special case' render queue list

Method Details

AddRenderQueue() public method

Adds an item to the 'special case' render queue list.

Normally all render queues are rendered, in their usual sequence, only varying if a RenderQueueListener nominates for the queue to be repeated or skipped. This method allows you to add a render queue to a 'special case' list, which varies the behaviour. The effect of this list depends on the 'mode' in which this list is in, which might be to exclude these render queues, or to include them alone (excluding all other queues). This allows you to perform broad selective rendering without requiring a RenderQueueListener.

public AddRenderQueue ( RenderQueueGroupID queueId ) : void
queueId	RenderQueueGroupID	The identifier of the queue which should be added to the /// special case list. Nothing happens if the queue is already in the list.
return	void

ClearRenderQueues() public method

Clears the 'special case' render queue list.

public ClearRenderQueues ( ) : void
return	void

IsRenderQueueToBeProcessed() public method

Returns whether or not the named queue will be rendered based on the current 'special case' render queue list and mode.

public IsRenderQueueToBeProcessed ( RenderQueueGroupID queueId ) : bool
queueId	RenderQueueGroupID	The identifier of the queue which should be tested
return	bool

RemoveRenderQueue() public method

Removes an item to the 'special case' render queue list

public RemoveRenderQueue ( RenderQueueGroupID queueId ) : void
queueId	RenderQueueGroupID	The identifier of the queue which should be removed from the /// special case list. Nothing happens if the queue is not in the list.
return	void