CustomRenderer Class Referenceabstract

This class is useful when one wants to provide custom drawing functions, but still want all the input variables provided in the standard Unity Renderer component. The unity class is sealed, but this version is not. This class provides no functionality beyond storage of variables, it is up to descendant classes to provide the drawing routines, and execute them at the appropriate times. A few functions for which a default value would make sense, are declare as abstract, and MUST be defined by descendant classes.

Public Member Functions

virtual void GetClosestReflectionProbes (List< ReflectionProbeBlendInfo > result)
 
virtual void GetPropertyBlock (out MaterialPropertyBlock dest)
 Matches the form of the unity Renderer function of the same name.
 
abstract void GetPropertyBlock (out MaterialPropertyBlock dest, int materialIndex)
 Matches the form of the unity Renderer function of the same name, but has an additional parameter to handle multiple materials.
 
virtual bool HasColor ()
 Specifies if the material this instance uses has a _Color
 
virtual bool HasColor (int matIndex)
 Specifies if the material this instance uses, specified by the index has a _Color
 
virtual bool HasTexture ()
 Specifies if the material this instance uses has a _MainTexture
 
virtual bool HasTexture (int matIndex)
 Specifies if the material this instance uses, specified by the index has a _MainTexture
 
abstract void OnRenderObject ()
 
virtual void RebuildPropertyBlock ()
 This function will be invoked wen the property block needs to be rebuilt. For example, if it contains a texture, and a texture is added
 
abstract void RebuildPropertyBlock (int matIndex)
 This function will be invoked wen the property block needs to be rebuilt. For example, if it contains a texture, and a texture is added
 
virtual void SetPropertyBlock (MaterialPropertyBlock dest)
 Matches the form of the unity Renderer function of the same name.
 
abstract void SetPropertyBlock (MaterialPropertyBlock dest, int materialIndex)
 Matches the form of the unity Renderer function of the same name, but has an additional parameter to handle multiple materials.
 

Public Attributes

Material[] localSharedMats
 
bool m_allowOcclusionWhenDynamic
 
int m_lightmapIndex
 
Vector4 m_lightmapScaleOffset
 
GameObject m_lightProbeProxyVolumeOverride
 
LightProbeUsage m_lightProbeUsage
 
MotionVectorGenerationMode m_motionVectorGenerationMode
 
Transform m_probeAnchor
 
int m_realtimeLightmapIndex
 
Vector4 m_realtimeLightmapScaleOffset
 
bool m_receiveShadows
 
ReflectionProbeUsage m_reflectionProbeUsage
 
ShadowCastingMode m_shadowCastingMode
 
int m_sortingLayerID
 
int m_sortingOrder
 

Protected Member Functions

virtual void OnEnable ()
 

Properties

virtual bool allowOcclusionWhenDynamic [get, set]
 
abstract Bounds bounds [get]
 
virtual bool castShadows [get]
 
virtual Color color [get, set]
 Provides IGraphicsColorInterface functionality. will get/set the default color in the first material of this object
 
virtual bool colorInterfaceEnabled [get, set]
 
virtual Material[] drawMaterials [get]
 
bool isPartOfStaticBatch [get]
 
virtual bool isViewable [get, set]
 
virtual bool isVisible [get, set]
 
virtual int lightmapIndex [get, set]
 
virtual Vector4 lightmapScaleOffset [get, set]
 
virtual Vector4 lightmapTilingOffset [get, set]
 
virtual Transform lightProbeAnchor [get, set]
 
virtual GameObject lightProbeProxyVolumeOverride [get, set]
 
virtual LightProbeUsage lightProbeUsage [get, set]
 
Matrix4x4 localToWorldMatrix [get]
 
virtual Material Material [get, set]
 
virtual Material[] Materials [get, set]
 
virtual MotionVectorGenerationMode motionVectorGenerationMode [get, set]
 
virtual bool motionVectors [get, set]
 
virtual Transform probeAnchor [get, set]
 
virtual int realtimeLightmapIndex [get, set]
 
virtual Vector4 realtimeLightmapScaleOffset [get, set]
 
virtual bool receiveShadows [get, set]
 
virtual ReflectionProbeUsage reflectionProbeUsage [get, set]
 
virtual ShadowCastingMode shadowCastingMode [get, set]
 
virtual Material sharedMaterial [get, set]
 
virtual Material[] sharedMaterials [get, set]
 
virtual int sortingLayerID [get, set]
 
virtual string sortingLayerName [get]
 
virtual int sortingOrder [get, set]
 
virtual bool useLightProbes [get, set]
 
Matrix4x4 worldToLocalMatrix [get]
 
- Properties inherited from IGraphicsColorInterface
Color color [get, set]
 Accessor that stores and retries the color itself.
 
bool colorInterfaceEnabled [get, set]
 When set to false, the color is not actually changed.
 
- Properties inherited from IGraphicsBounds
Bounds bounds [get]
 local bounds of object.
 
Transform transform [get]
 reference to the Transform of this object. Used when providing the bounds relative to another transform in the hierarchy.
 
- Properties inherited from IGraphicsViewable
bool isViewable [get, set]
 Accessor used to set/get the current isViewable state.
 
+ Inheritance diagram for CustomRenderer:
+ Collaboration diagram for CustomRenderer: