Catlike Coding
Unity Code Documentation
Protected Member Functions | List of all members
CatlikeCoding.TextBox.ClippedTextBoxCollider3D Class Reference

Clipped element that adds clipping support to a text box and also manages a 3D box collider. More...

Inherits CatlikeCoding.TextBox.ClippedTextBox.

Protected Member Functions

override void OnClipBoundsChanged ()
 Called when the clip bounds have changed, because the hierarchy bounds have changed. More...
 
override void OnTextBoxRendered (TextBox textBox)
 This method is called when the Rendered event of the relevant text box is triggered. More...
 
- Protected Member Functions inherited from CatlikeCoding.TextBox.ClippedTextBox
override void OnDestroy ()
 Called by Unity when the component is destroyed. More...
 
override void OnEnable ()
 Called by Unity when the component is enabled. More...
 
- Protected Member Functions inherited from CatlikeCoding.Clipping.ClippedElement
virtual void OnContentBoundsChanged ()
 Called when the content bounds have changed, by setting ContentBounds. More...
 

Additional Inherited Members

- Public Member Functions inherited from CatlikeCoding.Clipping.ClippedElement
void InitializeClipHierarchy ()
 Initialize the clip hierarchy. This method is already called at the appropriate places, you typically should have no reason to call it yourself. More...
 
void UpdateClipHierarchy ()
 Update the clip hierarchy if this element's parent changed. Call this method after changing the transform parent of this element, if it was or is now part of a clip hierarchy. More...
 
void UpdateHierarchyBounds ()
 Update the bounds of the entire clip hierarchy that this element is a part of. More...
 
- Public Attributes inherited from CatlikeCoding.TextBox.ClippedTextBox
bool ignoreOverflowBox = true
 Whether to ignore Rendered events from an overflow box. More...
 
- Public Attributes inherited from CatlikeCoding.Clipping.ClippedElement
bool clipsChildren
 Whether the element uses its content bounds to clip its children. More...
 
bool notifiesParent = true
 Whether the element notifies its parent when its bounds have changed. More...
 
- Protected Attributes inherited from CatlikeCoding.TextBox.ClippedTextBox
TextBox textBox
 The text box component attached to the same game object. More...
 
- Protected Attributes inherited from CatlikeCoding.Clipping.ClippedElement
Bounds2D clipBounds
 Clip bounds. More...
 
List< ClippedElementclipChildren
 Clip children. More...
 
ClippedElement clipParent
 Clip parent. More...
 
Bounds2D contentBounds
 Content bounds. More...
 
- Properties inherited from CatlikeCoding.Clipping.ClippedElement
Bounds2D ClipBounds [get]
 Get the clip bounds. More...
 
Bounds2D ContentBounds [get, set]
 Get or set the content bounds. More...
 
Bounds2D ContentBoundsForParent [get]
 Get the content bounds for use by the element's direct parent. More...
 

Detailed Description

Clipped element that adds clipping support to a text box and also manages a 3D box collider.

Member Function Documentation

override void CatlikeCoding.TextBox.ClippedTextBoxCollider3D.OnClipBoundsChanged ( )
protectedvirtual

Called when the clip bounds have changed, because the hierarchy bounds have changed.

Does nothing. Override if you need to respond to this change.

Reimplemented from CatlikeCoding.TextBox.ClippedTextBox.

override void CatlikeCoding.TextBox.ClippedTextBoxCollider3D.OnTextBoxRendered ( TextBox  textBox)
protectedvirtual

This method is called when the Rendered event of the relevant text box is triggered.

Subclasses should call the base method to make sure the content bounds are set correctly.

Parameters
textBoxText box.

Reimplemented from CatlikeCoding.TextBox.ClippedTextBox.