Editor.BrushBuilder

Extends: Object
Modifiers: abstract native
Source code

BrushBuilder: Base class of UnrealEd brush builders.

Tips for writing brush builders:

* Always validate the user-specified and call BadParameters function
if anything is wrong, instead of actually building geometry.
If you build an invalid brush due to bad user parameters, you'll
cause an extraordinary amount of pain for the poor user.

* When generating polygons with more than 3 vertices, BE SURE all the
polygon's vertices are coplanar! Out-of-plane polygons will cause
geometry to be corrupted.

Core.Object
|   
+-- Editor.BrushBuilder

Direct Known Subclasses:

ConeBuilder, CubeBuilder, CurvedStairBuilder, CylinderBuilder, LinearStairBuilder, SheetBuilder, SpiralStairBuilder, TerrainBuilder, TetrahedronBuilder, VolumetricBuilder

Constants Summary

Inherited Contants from Core.Object
MaxInt, Pi, RF_NotForClient, RF_NotForEdit, RF_NotForServer, RF_Public, RF_Transactional, RF_Transient

Variables Summary
name	Group
bool	MergeCoplanars
array<BuilderPoly>	Polys
array<vector>	Vertices
BrushBuilder
string	BitmapFilename
string	ToolTip

Inherited Variables from Core.Object
Class, Name, ObjectFlags, ObjectInternal[6], Outer

Enumerations Summary

Inherited Enumerations from Core.Object
ESheerAxis

Structures Summary
BuilderPoly VertexIndices, Direction, Item, PolyFlags

Inherited Structures from Core.Object
BoundingBox, BoundingVolume, Color, Coords, Guid, Plane, Rotator, Scale, Vector

Functions Summary
	bool	BadParameters (optional string msg)
		BeginBrush (bool MergeCoplanars, name Group)
	bool	Build ()
	bool	EndBrush ()
	int	GetPolyCount ()
	vector	GetVertex (int i)
	int	GetVertexCount ()
		Poly3i (int Direction, int i, int j, int k, optional name ItemName, optional int PolyFlags)
		Poly4i (int Direction, int i, int j, int k, int l, optional name ItemName, optional int PolyFlags)
		PolyBegin (int Direction, optional name ItemName, optional int PolyFlags)
		PolyEnd ()
		Polyi (int i)
	int	Vertex3f (float x, float y, float z)
	int	Vertexv (vector v)

Inherited Functions from Core.Object
!, !=, $, %, &, &&, , , =, +, ++, +=, -, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, Abs, Asc, Atan, BeginState, Caps, Chr, Clamp, ClassIsChildOf, Cos, Cross, Disable, Dot, DynamicLoadObject, Enable, EndState, Exp, FClamp, FMax, FMin, FRand, GetAxes, GetEnum, GetPropertyText, GetStateName, GetUnAxes, GotoState, InStr, Invert, IsA, IsInState, Left, Len, Lerp, Localize, Log, Loge, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, OrthoRotation, Rand, RandRange, ResetConfig, Right, RotRand, SaveConfig, SetPropertyText, Sin, Smerp, Sqrt, Square, StaticSaveConfig, Tan, VRand, VSize, Warn, ^, ^^, \|, \|\|, ~, ~=

Inherited Functions from Core.Object

!, !=, $, %, &, &&, *, **, *=, +, ++, +=, -, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, Abs, Asc, Atan, BeginState, Caps, Chr, Clamp, ClassIsChildOf, Cos, Cross, Disable, Dot, DynamicLoadObject, Enable, EndState, Exp, FClamp, FMax, FMin, FRand, GetAxes, GetEnum, GetPropertyText, GetStateName, GetUnAxes, GotoState, InStr, Invert, IsA, IsInState, Left, Len, Lerp, Localize, Log, Loge, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, OrthoRotation, Rand, RandRange, ResetConfig, Right, RotRand, SaveConfig, SetPropertyText, Sin, Smerp, Sqrt, Square, StaticSaveConfig, Tan, VRand, VSize, Warn, ^, ^^, |, ||, ~, ~=

Variables Detail

Group Source code

var private name Group;

MergeCoplanars Source code

var private bool MergeCoplanars;

Polys Source code

var private array<BuilderPoly> Polys;

Vertices Source code

var private array<vector> Vertices;

BrushBuilder

BitmapFilename Source code

var(BrushBuilder) string BitmapFilename;

ToolTip Source code

var(BrushBuilder) string ToolTip;

Structures Detail

BuilderPoly Source code

struct BuilderPoly
{

var int Direction;
var name Item;
var int PolyFlags;
var array<int> VertexIndices;

};

Functions Detail

BadParameters Source code

function bool BadParameters (optional string msg)

BeginBrush Source code

function BeginBrush (bool MergeCoplanars, name Group)

Build Source code

event bool Build ()

EndBrush Source code

function bool EndBrush ()

GetPolyCount Source code

function int GetPolyCount ()

GetVertex Source code

function vector GetVertex (int i)

GetVertexCount Source code

function int GetVertexCount ()

Poly3i Source code

function Poly3i (int Direction, int i, int j, int k, optional name ItemName, optional int PolyFlags)

Poly4i Source code

function Poly4i (int Direction, int i, int j, int k, int l, optional name ItemName, optional int PolyFlags)

PolyBegin Source code

function PolyBegin (int Direction, optional name ItemName, optional int PolyFlags)

PolyEnd Source code

function PolyEnd ()

Polyi Source code

function Polyi (int i)

Vertex3f Source code

function int Vertex3f (float x, float y, float z)

Vertexv Source code

function int Vertexv (vector v)

Defaultproperties

defaultproperties
{
    BitmapFilename="BBGeneric"
    ToolTip="Generic Builder"
}

Creation time: Wed 26/5/2004 10:46:42.593 - Created with UnCodeX