Rotorz Tile System Icon
Rotorz Tile System for Unity
API Reference
Available on the Unity Asset Store
TOC

OrientedBrush Class

Oriented tile brush.
public class OrientedBrush : Brush, 
	IMaterialMappings, ICoalescableBrush
public class OrientedBrush extends Brush
	implements IMaterialMappings, ICoalescableBrush

Refer to Oriented Brushes section of user guide for further information.

Methods

AddOrientation(Int32)
Adds orientation to brush.
AddOrientation(Int32, Boolean)
Adds orientation to brush optionally with rotational symmetry.
ApplyTransforms(IBrushContext, TileData, Brush)
Apply transforms to newly painted tile and orientate against tile system.
Awake()
Invoked when brush first becomes active.
(Overrides Brush.Awake().)
CalculateManualOffset(IBrushContext, TileData, Transform, Vector3, Quaternion, Vector3, Brush)
Calculates offset from actual tile position and where tile would normally be positioned by brush. This is used to preserve manually tweaked offsets when tiles are refreshed.
CountTileVariations(Int32)
Count the number of tile variations.
CreateTile(IBrushContext, TileData)
Create visual representation of tile.
Cycle(TileSystem, TileIndex, Int32)
Cycle through tile variations.
(Inherited from Brush.)
Cycle(TileSystem, Int32, Int32, Int32)
Cycle through tile variations.
(Inherited from Brush.)
CycleWithSimpleRotation(TileSystem, TileIndex, Int32, Int32)
Cycle through tile variations and/or rotation indices.
(Inherited from Brush.)
CycleWithSimpleRotation(TileSystem, Int32, Int32, Int32, Int32)
Cycle through tile variations and/or rotation indices.
(Inherited from Brush.)
FindClosestOrientation(Int32)
Finds closest match for the specified orientation mask.
FindClosestOrientationMask(Int32)
Finds mask of orientation that best matches the specified orientation mask.
FindOrientation(Int32)
Finds the specified orientation.
GetNthMaterial(Int32)
Gets the nth material from available renderers.
GetTransformMatrix(TileSystem, TileIndex, Int32, Transform)
Gets matrix that describes transformation of tile painted using brush in local space of tile system.
(Inherited from Brush.)
GetTransformMatrix(TileSystem, Int32, Int32, Int32, Transform)
Gets matrix that describes transformation of tile painted using brush in local space of tile system.
(Inherited from Brush.)
GetUserFlag(Int32)
Get state of custom user flag.
(Inherited from Brush.)
OnAfterDeserialize()
See Unity documentation OnAfterDeserialize() for further information regarding this method.
OnBeforeSerialize()
See Unity documentation OnBeforeSerialize() for further information regarding this method.
OnDrawImmediatePreview(IBrushContext, TileData, Material, Brush)
Draws preview of tile using the Unity graphics or gizmos class.
Paint(TileSystem, TileIndex)
Paint tile using brush.
(Inherited from Brush.)
Paint(TileSystem, TileIndex, Int32)
Paint tile using brush.
(Inherited from Brush.)
Paint(TileSystem, Int32, Int32)
Paint tile using brush.
(Inherited from Brush.)
Paint(TileSystem, Int32, Int32, Int32)
Paint tile using brush.
(Inherited from Brush.)
PaintWithSimpleRotation(TileSystem, TileIndex, Int32)
Paint tile with simple rotation transformation.
(Inherited from Brush.)
PaintWithSimpleRotation(TileSystem, TileIndex, Int32, Int32)
Paint tile with simple rotation transformation.
(Inherited from Brush.)
PaintWithSimpleRotation(TileSystem, Int32, Int32, Int32)
Paint tile with simple rotation transformation.
(Inherited from Brush.)
PaintWithSimpleRotation(TileSystem, Int32, Int32, Int32, Int32)
Paint tile with simple rotation transformation.
(Inherited from Brush.)
PickRandomVariationIndex(Int32)
Get random tile variation.
PostProcessTile(IBrushContext, TileData)
Post process newly painted tile.
(Inherited from Brush.)
PrepareTileData(IBrushContext, TileData, Int32)
Prepare tile data.
Refresh(TileSystem, TileIndex, RefreshFlags)
Refresh a tile.
(Inherited from Brush.)
Refresh(TileSystem, Int32, Int32, RefreshFlags)
Refresh a tile.
(Inherited from Brush.)
RemoveOrientation(Int32)
Removes orientation from brush.
SetUserFlag(Int32, Boolean)
Set state of custom user flag.
(Inherited from Brush.)
SyncGroupedVariations(Int32)
Synchronise variations of grouped orientations from specified orientation.

Extension Methods

IsUsingCoalesceWithBrushGroups
Determines whether CoalesceWithBrushGroups is applicable for coalesable brush.
RemapMaterial
Remap specified source material to the target material.

Fields

applyPrefabTransform
Indicates when prefab transform should be used to transform painted tiles.
(Inherited from Brush.)
customPreviewDesignTime
Indicates whether custom preview should be used at design time.
(Inherited from Brush.)
customPreviewImage
Allows custom preview image to be assigned to brush.
(Inherited from Brush.)
disableImmediatePreview
Indicates whether immediate preview should be disabled for this brush.
(Inherited from Brush.)
forceLegacySideways
Indicates if legacy behaviour should be assumed when painting tiles on tile systems that have sideways facing tiles.
(Inherited from Brush.)
forceOverrideFlags
Indicates if flags of nested brushes should be overridden.
group
Group that brush belong to.
(Inherited from Brush.)
layer
Layer to assign to game objects that are attached to painted tiles.
(Inherited from Brush.)
overrideLayer
Indicates whether brush should override the layer of game objects that are attached to painted tiles when applicable.
(Inherited from Brush.)
overrideTag
Indicates whether brush should override the tag of game objects that are attached to painted tiles when applicable.
(Inherited from Brush.)
overrideTransforms
Indicates if this brush should override the transforms of target brushes.
(Inherited from Brush.)
scaleMode
Indicates how painted tiles should be scaled.
(Inherited from Brush.)
tag
Tag to assign to game objects that are attached to painted tiles.
(Inherited from Brush.)
transformScale
Scale to apply when transforming painted tiles.
(Inherited from Brush.)
visibility
Visibility of brush in user interfaces.
(Inherited from Brush.)

Properties

CanOverrideTagAndLayer
Gets a value indicating whether layer and tag properties can be overridden by this Brush.
CanPreserveTransform
Gets a value indicating whether transform of attached game object can be preserved when refreshing tiles.
(Inherited from Brush.)
CategoryId
Gets or sets identifier of the category that the brush belongs to.
(Inherited from Brush.)
Coalesce
Gets or sets the coalescing rule that defines how painted tiles orientate with one another.
CoalesceWithBorder
Gets or sets a value indicating whether painted tiles can coalesce with border of tile system.
CoalesceWithBrushGroups
Gets editable collection of brush groups that painted tiles can coalesce with.
CoalesceWithRotated
Gets or sets a value indicating whether painted tiles can coalesce with tiles which have been painted with a different rotation.
DefaultOrientation
Gets the default orientation.
DefaultOrientationMask
Gets or sets bit mask that identifies the default orientation.
DesignableType
Gets user friendly name of designable type.
FallbackMode
Gets or sets the fallback mode.
MaterialMappingFrom
Gets or sets list of materials to map from.
MaterialMappingTo
Gets or sets list of materials to map to.
Orientations
Gets read-only collection of orientations.
PerformsAutomaticOrientation
Gets a value indicating whether brush automatically orientates tiles.
Smooth
Gets or sets a value that indicates whether the normals of tiles painted using brush should be smoothed when tile system is built.
(Inherited from Brush.)
SolidFlag
Gets or sets a value indicating whether painted tiles should be flagged as solid.
(Inherited from Brush.)
Static
Gets or sets a value that indicates if brush is static.
(Inherited from Brush.)
UseWireIndicatorInEditor
Gets a value indicating whether to use wireframe cursor when painting in the editor. When false an alternative representation can be used instead.

Remarks

Selects and paints tiles based upon their orientation and can optionally pick from multiple variations. Prefabs can be assigned to each variation which are then instantiated upon being painted. It is also possible to specify certain types of other brushes for variations.

Inheritance Hierarchy

System.Object
  Object
    ScriptableObject
      Rotorz.Tile.Brush
        Rotorz.Tile.OrientedBrush

See Also

Reference