Classes And Mehods In VSL

From Virtools Wiki

I created this page in the hope that it will become a complete list of all available methods so that each method can get its own page explaining how it works with example code etc. The Virtools reference documentation does provide this list, but it has no detailed descriptions of each method and I find the documentation search function quite clumsy and the documentation itself often not very good. I hope other people will start creating links to pages explaining each method in detail. I've made a start with cleaning up the list, hopefully I'll get some help with this because it's a very tedious and time-consuming task :-)
/<entyman

Contents 1 ActionContext (ac) 2 Animation 3 Array 4 ArrayString 5 BaseString 6 Bbox 7 BeObject 8 BehaviorContext (bc) 9 BitArray 10 BitmapData 11 Camera 12 Character 13 CloudAttribute 14 CloudIterator 15 CloudSelection 16 Color 17 Cone 18 Curve 19 Curve2D 20 Curve2DPoint 21 CurvePoint 22 DataRow 23 Entity2D 24 Entity3D 25 FloatArray 26 Frustum 27 GUID 28 Grid 29 Group 30 IntArray 31 IntersectionDesc 32 Layer 33 Light 34 Material 35 Matrix 36 Mesh 37 OBB 38 Object 39 ObjectArray 40 PatchMesh 41 Place 42 Plane 43 PointCloud 44 Quaternion 45 Ray 46 Rect 47 RenderContext 48 RenderManager 49 RenderObject 50 Scene 51 ScriptContext 52 Sphere 53 Sprite 54 Sprite3D 55 String 56 StringTokenizer 57 Texture 58 Timer 59 Vector 60 Vector2D 61 Vector2DArray 62 Vector4 63 Vector4Array 64 VectorArray 65 WaveFormat 66 WaveSound

ActionContext (ac)

This class has no equivalent in the Schematic

Parent Class:

• ScriptContext

Members:

• mouse (Vector2D)
• updateselection (bool)
• selected (Object)
• selection (ObjectArray)

Animation

Parent Class:

• SceneObject

Methods:

• bool CanBeInterrupt()
• void CenterAnimation( float fram )
• Animation CreateMergedAnimation( Animation anim2, bool dynamic )
• float CreateTransition( Animation in, Animation out, int OutTransitionMode, float length, float FrameTo )
• bool DoesCharacterTakeOrientation()
• Character GetCharacter()
• int GetFlags()
• float GetFrame()
• float GetLength()
• float GetLinkedFrameRate()
• float GetMergeFactor()
• float GetNextFrame( float delta_t )
• Entity3D GetRootEntity()
• CK_SECONDARYANIMATION_FLAGS GetSecondaryAnimationMode()
• float GetStep()
• CK_ANIMATION_TRANSITION_MODE GetTransitionMode()
• bool IsLinkedToFrameRate()
• bool IsMerged()
• void LinkToFrameRate( bool link, float fps )
• void SetCanBeInterrupt( bool can )
• void SetCharacterOrientation( bool orient )
• void SetCurrentStep( float Step )
• void SetFlags( int flags )
• void SetFrame( float frame )
• void SetLength( float nbframe )
• void SetMergeFactor( float factor )
• void SetSecondaryAnimationMode( CK_SECONDARYANIMATION_FLAGS mode )
• void SetStep( float step )
• void SetTransitionMode( CK_ANIMATION_TRANSITION_MODE mode )

Array

Parent Class

• BeObject

Methods

• void AddRow()
• void CheckPostDeletion()
• void CheckPreDeletion()
• void Clear( bool Params )
• void ColumnTransform( int c, CK_BINARYOPERATOR op, int value )
• void ColumnsOperate( int c1, CK_BINARYOPERATOR op, int c2, int cr )
• void CreateGroup( int mc, CK_COMPOPERATOR op, int key, int size, Group group, int ec = 0 )
• DataRow FindRow( int c, CK_COMPOPERATOR op, int key, int size = 0, int startindex = 0 )
• int FindRowIndex( int c, CK_COMPOPERATOR op, int key, int size = 0, int startingindex = 0 )
• CK_CLASSID GetClassID()
• int GetColumnCount()
• str GetColumnName( int c )
• GUID GetColumnParameterGuid( int c )
• CK_ARRAYTYPE GetColumnType( int c )
• int GetCount( int c, CK_COMPOPERATOR op, int key, int size = 0 )
• int GetElement( int i, int c )
• Object GetElementObject( int i, int c )
• int GetElementStringValue( int i, int c, str svalue )
• bool GetElementValue( int i, int c, ptr value )
• bool GetHighest( int c, int row )
• int GetKeyColumn()
• bool GetLowest( int c, int row )
• int GetMemoryOccupation()
• bool GetNearest( int c, ptr value, int row )
• DataRow GetRow( int n )
• int GetRowCount()
• int GetStringValue( int key, int c, str svalue )
• void InsertColumn( int cdest, CK_ARRAYTYPE type, str name, GUID paramguid )

• DataRow InsertRow( int n = -1 )

• int IsObjectUsed( Object o, CK_CLASSID cid )

• bool LoadElements( str string, bool append, int column )

• void MoveColumn( int csrc, int cdest )

• void MoveRow( int rsrc, int rdst )

• bool PasteShortcut( int i, int c Parameter pout )

• void PostLoad()

• int Product( int c )

• void RandomShuffle()

• void RemoveColumn( int c )

• void RemoveRow( int n )

• ParameterOut RemoveShortcut( int i, int c )

• void Reverse()

• void SetColumnName( int c, str name )

• void SetColumnType( int c, CK_ARRAYTYPE type, GUID paramguid )

• bool SetElementObject( int i, int c, Object object )

• bool SetElementStringValue( int i, int c, str svalue )

• bool SetElementValue( int i, int c, ptr value, int size = 0 )

• bool SetElementValueFromParameter( int i, int c, Parameter pout )

• void SetKeyColumn( int c )

• void Sort( int c, bool ascending )

• int Sum( int c )

• void SwapRows( int i1, int i2 )

• bool TestRow( int row, int c, CK_COMPOPERATOR op, int key, int size = 0 )

• void Unique( int c )
• bool WriteElements( Str string, int column, int number, bool iAppend = false )

ArrayString

Methods

• ArrayString = iArray (ArrayString)
• void Clear()
• void PopBack()
• void PushBack( String iValue )
• void PushFront( String iValue )
• void Reserve( int iSize )
• void Resize( int iSize )
• int Size()
• String [] iPos (int)

BaseString

This class has no equivalent in the Schematic

Methods

• str CStr()
• int Length()
• float ToFloat()
• int ToInt()
• char [] int i

Bbox

Members

• Max (Vector)
• Min (Vector)

Methods

• bool == iBox (Bbox)

• int Classify( Bbox box2, Vector pt )

• Vector GetCenter()

• Vector GetHalfSize()

• Vector GetSize()

• void Intersect( Bbox v )

• bool IsBoxInside( Bbox b )

• bool IsValid()

• void Merge( Bbox v )

• void Merge( Vector v )

• void Reset()

• void SetCenter( Vector center, Vector halfsize )

• void SetCorners( Vector min, Vector max )

• void SetDimension( Vector position, Vector size )

• void TransformFrom( Bbox sbox, Matrix Mat )

• void TransformTo( Vector pts, Matrix Mat )

• bool VectorIn( Vector v )

BeObject

Parent Class

• SceneObject

Methods

• int AddScript ckb (Behavior)

• int CallBehaviorCallbackFunction Message (int) behguid = 0 (GUID)

• void ExecuteBehaviors delta (float)

• int GetAttributeCount

• int GetAttributeType index (int)

• CK_CLASSID GetClassID

• float GetLastExecutionTime

• int GetLastFrameMessageCount

• int GetMemoryOccupation

• int GetPriority

• Behavior GetScript pos (int)

• int GetScriptCount

• bool IsInGroup group (Group)

• bool IsObjectUsed obj (Object) cid (CK_CLASSID)

• bool IsWaitingForMessages

• void RemoveAllAttributes

• int RemoveAllScripts

• Behavior RemoveScript id (int)

• void SetAsWaitingForMessages wait = true (bool)

• void SetPriority priority (int)

BehaviorContext (bc)

Parent Class

• ScriptContext

Methods

• BeObject GetOwner()

• void GetOwnerScriptName( String oName )

• BeObject GetTarget()

• bool IsRuntimeMode()

• void LaunchScene( Scene scene = 0, CK_SCENEOBJECTACTIVITY_FLAGS activity = 0, CK_SCENEOBJECTRESET_FLAGS reset = 0 )

• void SendMessage( Message iMessage, BeObject iDest )

• void SendMessage( str iMessage, BeObject iDest )

BitArray

This class has no equivalent in the Schematic

Methods

• BitArray -= a (BitArray)

• BitArray = a (BitArray)

• void And a (BitArray)

• void AppendBits n (int) v (int) bitcount (int)

• int BitSet

• bool CheckCommon a (BitArray)

• void CheckSize n (int)

• void Clear

• void Fill

• int GetMemoryOccupation addstatic = false (bool)

• int GetSetBitPosition n (int)

• int GetUnsetBitPosition n (int)

• void Invert

• int IsSet n (int)

• void Or a (BitArray)

• void Set n (int)

• int Size

• int TestSet n (int)

• int TestUnset n (int)

• void Unset n (int)

• void XOr a (BitArray)

• int [] n (int)

BitmapData

This class has no equivalent in the Schematic

Members

• m_Width (int)
• m_Height (int)
• m_CurrentSlot (int)
• m_PickThreshold (int)
• m_BitmapFlags (int)
• m_TransColor (int)
• m_SaveOptions (CK_BITMAP_SAVEOPTIONS)

Methods

• void AuthorizeConditionalNonPow2 Authorize (bool)

• bool CreateImage Width (int) Height (int) BPP = 32 (int) Slot = 0 (int) ImagePointer = 0 (ptr)

• int GetCurrentSlot

• VX_PIXELFORMAT GetDesiredVideoFormat

• int GetHeight

• str GetMovieFileName

• int GetPickThreshold

• int GetPixel x (int) y (int) slot = -1 (int)

• CK_BITMAP_SAVEOPTIONS GetSaveOptions

• int GetSlotCount

• str GetSlotFileName Slot (int)

• CK_BITMAP_SYSTEMCACHING GetSystemCaching

• int GetTransparentColor

• int GetWidth

• bool IsConditionalNonPow2Authorized

• bool IsCubeMap

• bool IsTransparent

• bool IsVolumeMap

• bool LoadMovieFile Name (String)

• bool LoadSlotImage Name (String) Slot = 0 (int)

• char LockSurfacePtr Slot = -1 (int)

• bool ReleaseAllSlots

• bool ReleaseSlot Slot (int)

• bool ReleaseSurfacePtr Slot = -1 (int)

• bool ResizeImages Width (int) Height (int)

• void SetCubeMap CubeMap (bool)

• bool SetCurrentSlot Slot (int)

• void SetDesiredVideoFormat pf (VX_PIXELFORMAT)

• void SetPickThreshold pt (int)

• bool SetPixel x (int) y (int) col (int) slot = -1 (int)

• void SetSaveOptions Options (CK_BITMAP_SAVEOPTIONS)

• bool SetSlotCount Count (int)

• bool SetSlotFileName Slot (int) Filename (str)

• void SetSystemCaching iOptions (CK_BITMAP_SYSTEMCACHING)

• void SetTransparent Transparency (bool)

• void SetTransparentColor Color (int)

• void SetVolumeMap VolumeMap (bool)

• bool ToRestore

Camera

Parent Class

• Entity3D

Methods

• void ComputeProjectionMatrix mat (Matrix)

• void GetAspectRatio width (int) height (int)

• float GetBackPlane

• float GetFov

• float GetFrontPlane

• float GetOrthographicZoom

• int GetProjectionType

• Entity3D GetTarget

• void ResetRoll

• void Roll angle (float)

• void SetAspectRatio width (int) height (int)

• void SetBackPlane back (float)

• void SetFov fov (float)

• void SetFrontPlane front (float)

• void SetOrthographicZoom zoom (float)

• void SetProjectionType proj (int)

• void SetTarget target (Entity3D)

Character

Parent Class

• Entity3D

Methods

• int AddAnimation anim (Animation)

• int AddBodyPart part (BodyPart)

• void AlignCharacterWithRootPosition

• void FlushSecondaryAnimations

• Animation GetActiveAnimation

• Animation GetAnimation index (int)

• int GetAnimationCount

• float GetAnimationLevelOfDetail

• BodyPart GetBodyPart index (int)

• int GetBodyPartCount

• void GetEstimatedVelocity deltat (float) velocity (Vector)

• Entity3D GetFloorReferenceObject

• Animation GetNextActiveAnimation

• BodyPart GetRootBodyPart

• Animation GetSecondaryAnimation index (int)

• int GetSecondaryAnimationsCount

• Animation GetWarper

• void GetWarperParameters TransitionMode (int) AnimSrc (Animation) FrameSrc (float) AnimDest (Animation) FrameDest (float) *bool IsAutomaticProcess

• int PlaySecondaryAnimation anim (Animation) StartingFrame = 0.000000 (float) PlayFlags = 1082130432 (CK_SECONDARYANIMATION_FLAGS) warplength = 5.000000 (float) LoopCount = 0 (int)

• void ProcessAnimation deltat = 1.000000 (float)

• int RemoveAnimation anim (Animation)

• int RemoveBodyPart part (BodyPart)

• int SetActiveAnimation anim (Animation)

• void SetAnimationLevelOfDetail LOD (float)

• void SetAutomaticProcess process = true (bool)

• void SetFloorReferenceObject FloorRef (Entity3D)

• int SetNextActiveAnimation anim (Animation) transitionmode (int) warplength = 0.000000 (float)

• int SetRootBodyPart part (BodyPart)

• int StopSecondaryAnimation anim (Animation) warp = false (bool) warplength = 5.000000 (float)

• int StopSecondaryAnimation anim (Animation) warplength = 5.000000 (float)

CloudAttribute

This class has no equivalent in the Schematic

Members

• ValueType (int)
• Name (String)
• BitsPerValue (int)
• Flags (int)

CloudIterator

This class has no equivalent in the Schematic

Methods

• void GetBox( Bbox oBox )

• int GetChildrenCount()

• int GetCurrentPointIndex()

• Vector GetCurrentPointPosition()

• Vector GetCurrentPointRealPosition()

• void GetRealBox( Bbox oBox )

• bool IsChildHere( int iBranchIndex )

• bool IsLeaf()

• bool IsNode()

• bool NextNode()

• bool NextPoint()

• bool ToChildByBranch( int iBranchIndex )

• bool ToChildByIndex( int iChildIndex )

• bool ToParent()

CloudSelection

This class has no equivalent in the Schematic

Methods

• void ClearSelection

• void EnableLighting iEnable (bool)

• Material GetDisplayMaterial

• Mesh GetDisplayMesh

• int GetDrawMode

• int GetMaximumPointCount

• String GetName

• int GetPointCount

• int GetPointOriginalIndex iPointIndex (int)

• Vector GetPointPosition iPointIndex (int)

• bool IsLightingEnabled

• bool IsUsingMaterialColor

• bool IsVisible

• void SetDisplayMaterial iMaterial (Material)

• void SetDisplayMesh iMesh (Mesh)

• void SetDrawMode iMode (int)

• void SetMaximumPointCount iMaxPointCount (int)

• void SetName iName (String)

• void SetVisible iVisible (bool)

• void UseMaterialColor iUse (bool)

Color

Members

• r (float)
• g (float)
• b (float)
• a (float)

Methods

• Color *= v (Color)

• Color *= s (float)

• Color += v (Color)

• Color -= v (Color)

• Color /= v (Color)

• Color /= s (float)

• void Check

• void Clear

• int GetRGB

• int GetRGBA

• float GetSquareDistance color (Color)

• void Set _r (float) _g (float) _b (float) _a (float)

• void Set _r (float) _g (float) _b (float)

• void Set _r (float)

• void Set col (int)

• void Set _r (int) _g (int) _b (int) _a (int)

• void Set _r (int) _g (int) _b (int)

Cone

This class has no equivalent in the Schematic

Members

• m_Origin (Vector)
• m_Direction (Vector)
• m_CosTheta (float)
• m_SinTheta (float)

Methods

• bool == iCone (Cone)

• float Distance iPoint (Vector)

• Vector GetDirection

• Vector GetOrigin

• int IsPointInside iPoint (Vector)

• void Transform dest (Cone) mat (Matrix)

Curve

Parent Class

• Entity3D

Methods

• int AddControlPoint pt (CurvePoint)

• void Close

• int CreateLineMesh

• Color GetColor

• CurvePoint GetControlPoint pos (int)

• int GetControlPointCount

• float GetFittingCoeff

• float GetLength

• int GetLocalPos step (float) pos (Vector) dir = 0 (Vector)

• int GetPos step (float) pos (Vector) dir = 0 (Vector)

• int GetStepCount

• int GetTangents index (int) in (Vector) out (Vector)

• int GetTangents pt (CurvePoint) in (Vector) out (Vector)

• int InsertControlPoint prev (CurvePoint) pt (CurvePoint)

• bool IsOpen

• void Open

• int RemoveAllControlPoints

• int RemoveControlPoint pt (CurvePoint) removeall = false (bool)

• void SetColor Color (Color)

• void SetFittingCoeff fit (float)

• int SetStepCount steps (int)

• int SetTangents index (int) in (Vector) out (Vector)

• int SetTangents pt (CurvePoint) in (Vector) out (Vector)

Curve2D

Methods

• void AddControlPoint iPosition (Vector2D)

• void DeleteControlPoint iPoint (Curve2DPoint)

• Curve2DPoint GetControlPoint iIndex (int)

• int GetControlPointCount

• float GetLength

• int GetPos step (float) pos (Vector2D)

• float GetY X (float)

Curve2DPoint

This class has no equivalent in the Schematic

Methods

• float GetBias

• float GetContinuity

• Curve2D GetCurve

• Vector2D GetInTangent

• float GetLength

• Vector2D GetOutTangent

• Vector2D GetPosition

• float GetTension

• bool IsLinear

• bool IsTCB

• void SetBias iBias (float)

• void SetContinuity iBias (float)

• void SetInTangent iInTangent (Vector2D)

• void SetLinear iLinear (bool)

• void SetOutTangent iOutTangent (Vector2D)

• void SetPosition iPosition (Vector2D)

• void SetTension iBias (float)

• void UseTCB iTCB (bool)

CurvePoint

Parent Class

• Entity3D

Methods

• float GetBias

• float GetContinuity

• Curve GetCurve

• float GetLength

• void GetTangents in (Vector) out (Vector)

• float GetTension

• bool IsLinear

• bool IsTCB

• void NotifyUpdate

• void SetBias b (float)

• void SetContinuity c (float)

• void SetLinear linear = false (bool)

• void SetTangents in (Vector) out (Vector)

• void SetTension t (float)

• void UseTCB use = true (bool)

DataRow

This class has no equivalent in the Schematic

Methods

• DataRow += iArray (DataRow)

• DataRow = iArray (DataRow)

• void Clear

• bool IsHere iValue (int)

• void PopBack

• void PushBack iValue (int)

• void PushFront iValue (int)

• int RemoveAt iPos (int)

• void Resize iSize (int)

• int Size

• int [] iPos (int)

Entity2D

Parent Class

• RenderObject

Methods

• int Draw context (RenderContext)

• void EnableClipToCamera Clip = true (bool)

• void EnableRatioOffset Ratio = true (bool)

• Entity2D GetChild i (int)

• int GetChildrenCount

• int GetFlags

• int GetHomogeneousRect rect (Rect)

• Material GetMaterial

• Entity2D GetParent

• int GetPosition vect (Vector2D) hom = false (bool) ref = 0 (Entity2D)

• void GetRect rect (Rect)

• int GetSize vect (Vector2D) hom = false (bool)

• void GetSourceRect rect (Rect)

• Entity2D HierarchyParser current (Entity2D)

• bool IsBackground

• bool IsClipToParent

• bool IsClippedToCamera

• bool IsHomogeneousCoordinates

• bool IsPickable

• bool IsRatioOffset

• bool IsUsingSourceRect

• void ModifyFlags add (int) remove = 0 (int)

• int Render context (RenderContext)

• void RestoreInitialSize

• void SetBackground back = true (bool)

• void SetClipToParent clip = false (bool)

• void SetFlags Flags (int)

• void SetHomogeneousCoordinates Coord = true (bool)

• int SetHomogeneousRect rect (Rect) KeepChildren = false (bool)

• void SetMaterial mat (Material)

• bool SetParent parent (Entity2D)

• void SetPickable Pick = true (bool)

• void SetPosition vect (Vector2D) hom = false (bool) KeepChildren = false (bool) ref = 0 (Entity2D)

• void SetRect rect (Rect) KeepChildren = false (bool)

• void SetSize vect (Vector2D) hom = false (bool) KeepChildren = false (bool)

• void SetSourceRect rect (Rect)

• void UseSourceRect Use = true (bool)

Entity3D

Parent Class

• RenderObject

Methods

• bool AddChild Child (Entity3D) KeepWorldPos = true (bool)

• bool AddChildren Children (ObjectArray) KeepWorldPos = true (bool)

• int AddMesh mesh (Mesh)

• void AddScale Scale (Vector) KeepChildren = false (bool) Local = true (bool)

• void AddScale X (float) Y (float) Z (float) KeepChildren = false (bool) Local = true (bool)

• bool AreAnimationIgnored

• void ChangeReferential Ref = 0 (Entity3D)

• bool CheckIfSameKindOfHierarchy Mov (Entity3D) SameOrder = false (bool)

• bool ConstructLocalMatrix Pos (Vector) Scale (Vector) Quat (Quaternion)

• bool ConstructLocalMatrixEx Pos (Vector) Scale (Vector) Quat (Quaternion) Shear (Quaternion) Sign (float)

• bool ConstructWorldMatrix Pos (Vector) Scale (Vector) Quat (Quaternion)

• bool ConstructWorldMatrixEx Pos (Vector) Scale (Vector) Quat (Quaternion) Shear (Quaternion) Sign (float)

• bool DestroySkin

• bool GetBaryCenter Pos (Vector)

• Bbox GetBoundingBox Local = false (bool)

• Entity3D GetChild pos (int)

• int GetChildrenCount

• Mesh GetCurrentMesh

• int GetFlags

• Bbox GetHierarchicalBox Local = false (bool)

• Matrix GetInverseWorldMatrix

• Matrix GetLastFrameMatrix

• Matrix GetLocalMatrix

• Mesh GetMesh pos (int)

• int GetMeshCount

• int GetMoveableFlags

• int GetObjectAnimationCount

• void GetOrientation Dir (Vector) Up (Vector) Right = 0 (Vector) Ref = 0 (Entity3D)

• Entity3D GetParent

• void GetPosition Pos (Vector) Ref = 0 (Entity3D)

• void GetQuaternion Quat (Quaternion) Ref = 0 (Entity3D)

• float GetRadius

• Place GetReferencePlace

• void GetRenderExtents rect (Rect)

• void GetScale Scale (Vector) Local = true (bool)

• Matrix GetWorldMatrix

• Entity3D HierarchyParser current (Entity3D)

• void IgnoreAnimations ignore = true (bool)

• void InverseTransform Dest (Vector) Src (Vector) Ref = 0 (Entity3D)

• void InverseTransformMany Dest (Vector) Src (Vector) count (int) Ref = 0 (Entity3D)

• void InverseTransformVector Dest (Vector) Src (Vector) Ref = 0 (Entity3D)

• bool IsAllInsideFrustrum

• bool IsAllOutsideFrustrum

• bool IsInViewFrustrum Dev (RenderContext) Flags = 0 (int)

• bool IsInViewFrustrumHierarchic Dev (RenderContext)

• bool IsPickable

• void LookAt Pos (Vector) Ref = 0 (Entity3D) KeepChildren = false (bool)

• int ModifyMoveableFlags Add (int) Remove (int)

• int RayIntersection Pos1 (Vector) Pos2 (Vector) Desc (IntersectionDesc) Ref = 0 (Entity3D) iOptions = 0 (CK_RAYINTERSECTION)

• bool RemoveChild Mov (Entity3D)

• int RemoveMesh mesh (Mesh)

• bool Render Dev (RenderContext) Flags = 0 (int)

• void Rotate Axis (Vector) Angle (float) Ref = 0 (Entity3D) KeepChildren = false (bool)

• void Rotate X (float) Y (float) Z (float) Angle (float) Ref = 0 (Entity3D) KeepChildren = false (bool)

• bool SetBoundingBox BBox (Bbox) Local = false (bool)

• Mesh SetCurrentMesh m (Mesh) add_if_not_here = true (bool)

• void SetFlags Flags (int)

• void SetLocalMatrix Mat (Matrix) KeepChildren = false (bool)

• void SetMoveableFlags flags (int)

• void SetOrientation Dir (Vector) Up (Vector) Right = 0 (Vector) Ref = 0 (Entity3D) KeepChildren = false (bool)

• bool SetParent Parent (Entity3D) KeepWorldPos = true (bool)

• void SetPickable Pick = true (bool)

• void SetPosition Pos (Vector) Ref = 0 (Entity3D) KeepChildren = false (bool)

• void SetPosition X (float) Y (float) Z (float) Ref = 0 (Entity3D) KeepChildren = false (bool)

• void SetQuaternion Quat (Quaternion) Ref = 0 (Entity3D) KeepChildren = false (bool) KeepScale = false (bool)

• void SetRenderAsTransparent Trans = true (bool)

• void SetScale Scale (Vector) KeepChildren = false (bool) Local = true (bool)

• void SetScale X (float) Y (float) Z (float) KeepChildren = false (bool) Local = true (bool)

• void SetWorldMatrix Mat (Matrix) KeepChildren = false (bool)

• void Transform Dest (Vector) Src (Vector) Ref = 0 (Entity3D)

• void TransformMany Dest (Vector) Src (Vector) count (int) Ref = 0 (Entity3D)

• void TransformVector Dest (Vector) Src (Vector) Ref = 0 (Entity3D)

• void Translate Vect (Vector) Ref = 0 (Entity3D) KeepChildren = false (bool)

• void Translate X (float) Y (float) Z (float) Ref = 0 (Entity3D) KeepChildren = false (bool)

• bool UpdateSkin

FloatArray

This class has no equivalent in the Schematic

Methods

• FloatArray += iArray (FloatArray)

• FloatArray = iArray (FloatArray)

• void Clear

• bool Erase iValue (float)

• bool EraseAt iPos (int)

• bool IsHere iValue (float)

• float PopBack

• void PushBack iValue (float)

• void PushFront iValue (float)

• void Reserve iSize (int)

• void Resize iSize (int)

• int Size

• float [] iPos (int)

Frustum

This class has no equivalent in the Schematic

Methods

• bool == iFrustum (Frustum)

• float Classify v (Bbox)

• float Classify b (Bbox) mat (Matrix)

• void ComputeVertices vertices (Vector)

• Plane GetBottomPlane

• float GetDMax

• float GetDMin

• float GetDRatio

• Vector GetDir

• Plane GetFarPlane

• Plane GetLeftPlane

• Plane GetNearPlane

• Vector GetOrigin

• float GetRBound

• float GetRF

• Vector GetRight

• Plane GetRightPlane

• float GetUBound

• float GetUF

• Vector GetUp

• Plane GetUpPlane

• bool IsInside v (Vector)

• void Transform invworldmat (Matrix)

• void Update

GUID

This class has no equivalent in the Schematic

Members

• d1 (int)
• d2 (int)

Grid

This class has no equivalent in the Schematic

Parent Class

• Entity3D

Methods

• int AddClassification classification (int)

• int AddClassification ClassificationName (str)

• Layer AddLayer type (int) Format = 0 (int)

• Layer AddLayer TypeName = (null) (str) Format = 0 (int)

• void ConstructMeshTexture opacity = 0.000000 (float)

• void DestroyMeshTexture

• float Get2dCoordsFrom3dPos pos3d (Vector) x (int) y (int)

• void Get3dPosFrom2dCoords pos3d (Vector) x (int) y (int)

• int GetGridPriority

• float GetHeightValidity

• Layer GetLayer type (int)

• Layer GetLayer TypeName (str)

• Layer GetLayerByIndex type (int)

• int GetLayerCount

• int GetLength

• CK_GRIDORIENTATION GetOrientationMode

• int GetWidth

• bool HasCompatibleClass ent (Entity3D)

• bool IsActive

• int RemoveAllLayers

• int RemoveClassification classification (int)

• int RemoveClassification ClassificationName (str)

• int RemoveLayer type (int)

• int RemoveLayer TypeName (str)

• void SetDimensions width (int) length (int) sizeX (float) sizeY (float)

• void SetGridPriority Priority (int)

• void SetHeightValidity HeightValidity (float)

• void SetOrientationMode orimode (CK_GRIDORIENTATION)

Group

Parent Class

• BeObject

Methods

• int AddObject o (BeObject)

• int AddObjectFront o (BeObject)

• void AddToScene scene (Scene) dependencies (bool)

• int CanBeHide

• void CheckPreDeletion

• void Clear

• CK_CLASSID GetClassID

• CK_CLASSID GetCommonClassID

• int GetMemoryOccupation

• BeObject GetObject pos (int)

• int GetObjectCount

• int InsertObjectAt o (BeObject) pos (int)

• int IsObjectUsed o (Object) cid (CK_CLASSID)

• void MoveObjectDown o (BeObject)

• void MoveObjectUp o (BeObject)

• void PostLoad

• void PreDelete

• void RemoveFromScene scene (Scene) dependencies (bool)

• BeObject RemoveObject pos (int)

• void RemoveObject obj (BeObject)

• void Show Show = 1065353216 (CK_OBJECT_SHOWOPTION)

IntArray

This class has no equivalent in the Schematic

Methods

• IntArray += iArray (IntArray)

• IntArray = iArray (IntArray)

• void Clear

• bool Erase iValue (int)

• bool EraseAt iPos (int)

• bool IsHere iValue (int)

• int PopBack

• void PushBack iValue (int)

• void PushFront iValue (int)

• void Reserve iSize (int)

• void Resize iSize (int)

• int Size

• int [] iPos (int)

IntersectionDesc

This class has no equivalent in the Schematic

Members

• Object (Entity3D)
• IntersectionPoint (Vector)
• IntersectionNormal (Vector)
• TexU (float)
• TexV (float)
• Distance (float)
• FaceIndex (int)

Layer

This class has no equivalent in the Schematic

Parent Class

• Object

Methods

• int GetFormat

• int GetOwner

• int GetSquareArray

• int GetType

• void GetValue x (int) y (int) val (ptr)

• bool GetValue2 x (int) y (int) val (ptr)

• bool IsVisible

• void SetFormat Format (int)

• void SetOwner owner (int)

• void SetSquareArray sqarray (int)

• void SetType Type (int)

• void SetValue x (int) y (int) val (ptr)

• bool SetValue2 x (int) y (int) val (ptr)

• void SetVisible vis = true (bool)

Light

Parent Class

• Entity3D

Methods

• void Active iActive (bool)

• bool GetActivity

• Color GetColor

• float GetConstantAttenuation

• float GetFallOff

• float GetFallOffShape

• float GetHotSpot

• float GetLightPower

• float GetLinearAttenuation

• float GetQuadraticAttenuation

• float GetRange

• bool GetSpecularFlag

• Entity3D GetTarget

• VXLIGHT_TYPE GetType

• void SetColor iColor (Color)

• void SetConstantAttenuation iFactor (float)

• void SetFallOff iAngle (float)

• void SetFallOffShape iFactor (float)

• void SetHotSpot iAngle (float)

• void SetLightPower iPower = 1.000000 (float)

• void SetLinearAttenuation iFactor (float)

• void SetQuadraticAttenuation iFactor (float)

• void SetRange iDistance (float)

• void SetSpecularFlag iEnable (bool)

• void SetTarget iTarget (Entity3D)

• void SetType iType (VXLIGHT_TYPE)

Material

Parent Class

• BeObject

Methods

• bool AlphaBlendEnabled

• bool AlphaTestEnabled

• void EnableAlphaBlend Blend = true (bool)

• void EnableAlphaTest Enable = true (bool)

• void EnablePerpectiveCorrection Perspective = true (bool)

• void EnableZWrite ZWrite = true (bool)

• VXCMPFUNC GetAlphaFunc

• char GetAlphaRef

• Color GetAmbient

• VXBLEND_MODE GetDestBlend

• Color GetDiffuse

• Parameter GetEffectParameter

• Color GetEmissive

• VXFILL_MODE GetFillMode

• float GetPower

• VXSHADE_MODE GetShadeMode

• Object GetShaderParamObject iParamName (str)

• void GetShaderParamValue iParamName (str) oBuffer (ptr)

• VXBLEND_MODE GetSourceBlend

• Color GetSpecular

• Texture GetTexture TexIndex = 0 (int)

• VXTEXTURE_ADDRESSMODE GetTextureAddressMode

• VXTEXTURE_BLENDMODE GetTextureBlendMode

• int GetTextureBorderColor

• VXTEXTURE_FILTERMODE GetTextureMagMode

• VXTEXTURE_FILTERMODE GetTextureMinMode

• VXCMPFUNC GetZFunc

• bool IsAlphaTransparent

• bool IsTwoSided

• bool PerspectiveCorrectionEnabled

• void SetAlphaFunc AlphaFunc = 1090519040 (VXCMPFUNC)

• void SetAlphaRef AlphaRef = (char)

• void SetAmbient Color (Color)

• bool SetAsCurrent (RenderContext) Lit = true (bool) TextureStage = 0 (int)

• void SetDestBlend BlendMode (VXBLEND_MODE)

• void SetDiffuse Color (Color)

• void SetEmissive Color (Color)

• void SetFillMode FillMode (VXFILL_MODE)

• void SetPower Value (float)

• void SetShadeMode ShadeMode (VXSHADE_MODE)

• void SetShaderByName iName (str)

• void SetShaderParamObject iParamName (str) Object (Object)

• void SetShaderParamValue iParamName (str) iBuffer (ptr)

• void SetSourceBlend BlendMode (VXBLEND_MODE)

• void SetSpecular Color (Color)

• void SetTexture Tex (Texture)

• void SetTexture TexIndex (int) Tex (Texture)

• void SetTextureAddressMode Mode (VXTEXTURE_ADDRESSMODE)

• void SetTextureBlendMode BlendMode (VXTEXTURE_BLENDMODE)

• void SetTextureBorderColor Color (int)

• void SetTextureMagMode FilterMode (VXTEXTURE_FILTERMODE)

• void SetTextureMinMode FilterMode (VXTEXTURE_FILTERMODE)

• void SetTwoSided TwoSided (bool)

• void SetZFunc ZFunc = 1082130432 (VXCMPFUNC)

• bool ZWriteEnabled

Matrix

Methods

• bool != mat (Matrix)

• Matrix * iMat (Matrix)

• Matrix *= mat (Matrix)

• bool == mat (Matrix)

• void Clear

• void Orthographic iZoom (float) iAspect (float) iNearPlane (float) iFarPlane (float)

• void OrthographicRect iLeft (float) iRight (float) iTop (float) iBottom (float) iNearPlane (float) iFarPlane (float)

• void Perspective iFov (float) iAspect (float) iNearPlane (float) iFarPlane (float)

• void PerspectiveRect iLeft (float) iRight (float) iTop (float) iBottom (float) iNearPlane (float) iFarPlane (float)

• void RecomposeMatrix Pos (Vector) Scale (Vector) Quat (Quaternion)

• void RecomposeMatrixEx Pos (Vector) Scale (Vector) Quat (Quaternion) Shear (Quaternion) Sign (float)

• void SetIdentity

• Vector4 [] i (int)

Mesh

Parent Class

• BeObject

Methods

• void ActivateAllChannels Active = true (bool)

• void ActivateChannel Index (int) Active = true (bool)

• int AddChannel Mat (Material) CopySrcUv = true (bool)

• int AddChannelExt Mat (Material) CopySrcUv = true (bool) ChanType = 0 (ChannelType)

• void ApplyGlobalMaterial Mat (Material)

• void BuildFaceNormals

• void BuildNormals

• void Clean KeepVertices = false (bool)

• void ColorChanged

• void Consolidate

• void CreateLineStrip StartingLine (int) Count (int) StartingVertexIndex (int)

• int CreatePM

• void DestroyPM

• void DissociateAllFaces

• void EnablePMGeoMorph enable (bool)

• void GetBaryCenter Vector (Vector)

• int GetChannelByMaterial mat (Material)

• int GetChannelCount

• VXBLEND_MODE GetChannelDestBlend Index (int)

• int GetChannelFlags Index (int)

• Material GetChannelMaterial Index (int)

• VXBLEND_MODE GetChannelSourceBlend Index (int)

• ChannelType GetChannelType ChanIndex (int)

• ptr GetColorsPtr Stride (int)

• int GetFaceCount

• Material GetFaceMaterial Index (int)

• Vector GetFaceNormal Index (int)

• Vector GetFaceVertex FaceIndex (int) VIndex (int)

• void GetFaceVertexIndex Index (int) Vertex1 (int) Vertex2 (int) Vertex3 (int)

• int GetFacesIndices

• int GetFlags

• void GetLine LineIndex (int) VIndex1 (int) VIndex2 (int)

• int GetLineCount

• VXMESH_LITMODE GetLitMode

• Bbox GetLocalBox

• Material GetMaterial index (int)

• int GetMaterialCount

• void GetModifierUV Index (int) U (float) V (float) channel = -1 (int)

• int GetModifierUVCount channel = -1 (int)

• void GetModifierVertex Index (int) pos (Vector)

• int GetModifierVertexCount

• ptr GetNormalsPtr Stride (int)

• int GetPMGeoMorphStep

• ptr GetPositionsPtr Stride (int)

• float GetRadius

• ptr GetSpecularColorsPtr Stride (int)

• ptr GetTextureCoordinatesPtr Stride (int) channel = -1 (int)

• int GetVertexColor Index (int)

• int GetVertexCount

• void GetVertexData Index (int) ChanIndex (int) DataDest (ptr)

• void GetVertexNormal Index (int) Vector (Vector)

• void GetVertexPosition Index (int) Vector (Vector)

• int GetVertexSpecularColor Index (int)

• void GetVertexTextureCoordinates Index (int) u (float) v (float) channel = -1 (int)

• float GetVertexWeight index (int)

• int GetVertexWeightsCount

• float GetVertexWeightsPtr

• int GetVerticesRendered

• VXTEXTURE_WRAPMODE GetWrapMode

• void InverseWinding

• bool IsChannelActive Index (int)

• bool IsChannelLit Index (int)

• bool IsPM

• bool IsPMGeoMorphEnabled

• bool IsTransparent

• void LitChannel Index (int) Lit = true (bool)

• void ModifierUVMove channel = -1 (int)

• void ModifierVertexMove RebuildNormals (bool) RebuildFaceNormals (bool)

• void NormalChanged

• void RemoveAllCallbacks

• void RemoveChannel Mat (Material)

• void RemoveChannel Index (int)

• int Render Dev (RenderContext) Mov (Entity3D)

• void ReplaceMaterial oldMat (Material) newMat (Material) merge = false (bool)

• void RotateVertices Vector (Vector) Angle (float)

• void ScaleVertices Vector (Vector) Pivot = 0 (Vector)

• void ScaleVertices X (float) Y (float) Z (float) Pivot = 0 (Vector)

• void SetChannelDestBlend Index (int) BlendMode (VXBLEND_MODE)

• void SetChannelFlags Index (int) Flags (int)

• void SetChannelMaterial Index (int) Mat (Material)

• void SetChannelSourceBlend Index (int) BlendMode (VXBLEND_MODE)

• void SetChannelType ChanIndex (int) ChanType (ChannelType) ForceReallocation = false (bool)

• void SetDefaultRenderCallBack

• bool SetFaceCount Count (int)

• void SetFaceMaterial FaceIndex (int) Mat (Material)

• void SetFaceMaterial FaceIndices (int) FaceCount (int) Mat (Material)

• void SetFaceVertexIndex FaceIndex (int) Vertex1 (int) Vertex2 (int) Vertex3 (int)

• void SetFlags Flags (int)

• void SetLine LineIndex (int) VIndex1 (int) VIndex2 (int)

• bool SetLineCount Count (int)

• void SetLitMode Mode (VXMESH_LITMODE)

• void SetModifierUV Index (int) U (float) V (float) channel = -1 (int)

• void SetModifierVertex Index (int) pos (Vector)

• void SetPMGeoMorphStep gs (int)

• void SetTransparent Transparency (bool)

• void SetVertexColor Index (int) Color (int)

• bool SetVertexCount Count (int)

• void SetVertexData Index (int) ChanIndex (int) DataSrc (ptr)

• void SetVertexNormal Index (int) Vector (Vector)

• void SetVertexPosition Index (int) Vector (Vector)

• void SetVertexSpecularColor Index (int) Color (int)

• void SetVertexTextureCoordinates Index (int) u (float) v (float) channel = -1 (int)

• void SetVertexWeight index (int) w (float)

• void SetVertexWeightsCount count (int)

• void SetVerticesRendered count (int)

• void SetWrapMode Mode (VXTEXTURE_WRAPMODE)

• void TranslateVertices Vector (Vector)

• void UVChanged channel = -1 (int)

• void UnOptimize

• void VertexMove

OBB

This class has no equivalent in the Schematic

Methods

• bool == iOBB (OBB)

• void Create box (Bbox) mat (Matrix)

• Vector GetAxes

• Vector GetAxis i (int)

• Vector GetCenter

• float GetExtent i (int)

• float GetExtents

• bool IsBoxInside b (Bbox)

• bool VectorIn v (Vector)

Object

Methods

• Object CKGetObject id (int)

• int CanBeHide

• ptr GetAppData

• Object GetCKObject id (int)

• int GetID

• int GetMemoryOccupation

• str GetName

• int GetObjectFlags

• bool IsDynamic

• bool IsHiddenByParent

• bool IsHierarchicallyHide

• bool IsInterfaceObj

• bool IsNotToBeSaved

• bool IsPrivate

• bool IsUpToDate

• bool IsVisible

• void ModifyObjectFlags add (int) remove (int)

• void SetAppData Data (ptr)

• void SetName Name (str) shared = false (bool)

• void Show show = 1065353216 (CK_OBJECT_SHOWOPTION)

ObjectArray

Methods

• ObjectArray += iArray (ObjectArray)

• ObjectArray = iArray (ObjectArray)

• void Clear

• bool Erase iObject (Object)

• bool EraseAt iIndex (int)

• bool IsHere iObject (Object)

• Object PopBack

• void PushBack iObject (Object)

• void PushFront iObject (Object)

• void Reserve iSize (int)

• void Resize iSize (int)

• int Size

• Object [] iIndex (int)

PatchMesh

Parent Class

• Mesh

Methods

• void BuildRenderMesh

• int FromMesh m (Mesh)

• int GetEdgeCount

• int GetIterationCount

• int GetPatchCount

• int GetPatchFlags

• Material GetPatchMaterial index (int)

• int GetPatchSM index (int)

• void GetTV index (int) u (float) v (float) Channel = -1 (int)

• int GetTVCount Channel = -1 (int)

• int GetTVPatchCount Channel = -1 (int)

• void GetVec index (int) cp (Vector)

• int GetVecCount

• Vector GetVecs

• void GetVert index (int) cp (Vector)

• int GetVertCount

• Vector GetVerts

• void SetEdgeCount count (int)

• void SetIterationCount count (int)

• void SetPatchCount count (int)

• void SetPatchFlags Flags (int)

• void SetPatchMaterial index (int) mat (Material)

• void SetPatchSM index (int) smoothing (int)

• void SetTV index (int) u (float) v (float) Channel = -1 (int)

• void SetTVCount count (int) Channel = -1 (int)

• void SetTVPatchCount count (int) Channel = -1 (int)

• void SetVec index (int) cp (Vector)

• void SetVert index (int) cp (Vector)

• void SetVertVecCount VertCount (int) VecCount (int)

• int ToMesh m (Mesh) stepcount (int)

Place

Parent Class

• Entity3D

Methods

• void AddPortal place (Place) portal (Entity3D)

• bool ComputeBestFitBBox p2 (Place) BBoxMatrix (Matrix)

• Place GetPortal i (int) portal (Entity3D)

• int GetPortalCount

• void RemovePortal place (Place) portal (Entity3D)

• Rect ViewportClip

Plane

This class has no equivalent in the Schematic

Members

• m_Normal (Vector)
• m_D (float)

Methods

• bool == iPlane (Plane)

• float Classify p (Vector)

• float Classify box (Bbox)

• float Classify box (Bbox) mat (Matrix)

• float ClassifyFace pt0 (Vector) pt1 (Vector) pt2 (Vector)

• void Create n (Vector) p (Vector)

• void Create a (Vector) b (Vector) c (Vector)

• float Distance p (Vector)

• Vector GetNormal

• Vector NearestPoint p (Vector)

• float XClassify boxaxis (Vector)

PointCloud

Parent Class

• Entity3D

Methods

• bool ClearAllData iKeepAttributes = true (bool) iKeepSelections = true (bool)

• bool CreateFromArray iArray (Array) iColumn1 = 0 (int) iColumn2 = -1 (int) iColumn3 = -1 (int)

• bool CreateFromAscFile iFileName (str)

• CloudSelection CreateSelection iName (String) iMaxSize = 250000 (int)

• void EnableLighting iEnable = true (bool)

• void GetClipPlane iClipPlaneIndex (int) oPlaneEquation (Plane)

• int GetClipPlaneCount

• int GetCloudAttributeCount

• CloudAttribute GetCloudAttributeDescription iAttributeIndex (int)

• int GetCloudAttributeIndexByName iName (BaseString)

• Material GetGlobalMaterial

• float GetGlobalPointSize

• int GetLOD

• int GetLODPointCount iLod (int)

• Vector GetLoadOffset

• float GetLoadScaleFactor

• int GetMemorySize

• float GetPickingPrecision

• int GetPointColor iPointIndex (int)

• float GetPointFloatAttribute iPointIndex (int) iAttributeIndex (int)

• int GetPointIntAttribute iPointIndex (int) iAttributeIndex (int)

• int GetPointIntensity iPointIndex (int)

• Vector GetPointNormal iPointIndex (int)

• int GetPointsCount

• CloudIterator GetRootIterator

• CloudSelection GetSelection iIndex (int)

• CloudSelection GetSelection iName (String)

• int GetSelectionCount

• int GetVertexBufferCount

• int GetVertexBufferMemorySize

• bool HasColors

• bool HasNormals

• bool IsCloudAttributeInVB iAttributeIndex (int)

• bool IsCloudAttributeUsed iAttributeIndex (int)

• bool IsLightingEnabled

• bool IsMainCloudVisible

• bool IsUsingMaterialColor

• bool IsUsingPointSprite

• bool LoadAttributesFromArray iAttributeIndex (int) iArray (Array) iColumn (int) iOffset = 0.000000 (float) iScale = 1.000000 (float)

• bool LoadAttributesFromTextFile iAttributeIndex (int) iFileName (str) iOffset = 0.000000 (float) iScale = 1.000000 (float)

• int RegisterCloudAttribute iAttributeDesc (CloudAttribute)

• void RemoveSelection iSelection (CloudSelection)

• void RemoveSelection iName (String)

• int SelectBox iBox (Bbox) iSelection (CloudSelection) iClearSelection = true (bool)

• int SelectBox iOBox (OBB) iSelection (CloudSelection) iClearSelection = true (bool)

• int SelectCone iCone (Cone) iSelection (CloudSelection) iClearSelection = true (bool)

• int SelectConvexObject iEnt (Entity3D) iSelection (CloudSelection) iClearSelection = true (bool)

• int SelectConvexObjectGroup iGroup (Group) iSelection (CloudSelection) iClearSelection = true (bool)

• int SelectConvexObjectGroup iObjects (ObjectArray) iSelection (CloudSelection) iClearSelection = true (bool)

• int SelectPoint iContext (RenderContext) iPoint (Vector2D) iSelection (CloudSelection) iClearSelection = true (bool)

• int SelectSphere iSphere (Sphere) iSelection (CloudSelection) iClearSelection = true (bool)

• void SetClipPlane iClipPlaneIndex (int) iPlaneEquation (Plane)

• void SetClipPlaneCount iClipPlaneCount (int)

• void SetCloudAttributeDescription iAttributeIndex (int) iDescription (CloudAttribute)

• void SetCloudAttributeInVB iAttributeIndex (int) iPutInVB (bool)

• void SetGlobalMaterial iMaterial (Material)

• void SetGlobalPointSize iPointSize (float)

• void SetLOD iLod (int)

• void SetLODPointCount iLod (int) iPointCount (int)

• void SetPickingPrecision iPointDistance (float)

• void SetPointColor iPointIndex (int) iColor (int)

• void SetPointFloatAttribute iPointIndex (int) iAttributeIndex (int) iValue (float)

• void SetPointIntAttribute iPointIndex (int) iAttributeIndex (int) iValue (int)

• void SetPointIntensity iPointIndex (int) iColor (char)

• void SetPointNormal iPointIndex (int) iColor (Vector)

• void SetReferentialPosition iPosition (Vector) iRef = 0 (Entity3D)

• void ShowMainCloud iShow (bool)

• void UnRegisterCloudAttribute iAttributeIndex (int)

• void UseCloudAttribute iAttributeIndex (int) iUse (bool)

• void UseColors iUseColors (bool)

• void UseMaterialColor iUse (bool)

• void UseNormals iUseNormals (bool)

• void UsePointSprite iUse (bool)

Quaternion

Members

• x (float)
• y (float)
• z (float)
• axis (Vector)
• angle (float)

Methods

• Quaternion * q (Quaternion)

• Quaternion *= s (float)

• Quaternion + q (Quaternion)

• Quaternion +

• Quaternion - q (Quaternion)

• Quaternion -

• Quaternion / q (Quaternion)

• void FromEulerAngles eax (float) eay (float) eaz (float)

• void FromMatrix Mat (Matrix) MatIsUnit = true (bool) RestoreMat = true (bool)

• void FromRotation Vector (Vector) Angle (float)

• void Multiply Quat (Quaternion)

• void Normalize

• void ToEulerAngles eax (float) eay (float) eaz (float)

• void ToMatrix Mat (Matrix)

• void ToRotation Vector (Vector) Angle (float)

• float [] i (int)

Ray

This class has no equivalent in the Schematic

Members

• m_Origin (Vector)
• m_Direction (Vector)

Methods

• bool == iRay (Ray)

• float Distance p (Vector)

• Vector GetDirection

• Vector GetOrigin

• void Interpolate p (Vector) t (float)

• float SquareDistance p (Vector)

• void Transform dest (Ray) mat (Matrix)

Rect

Members

• left (float)
• top (float)
• right (float)
• bottom (float)

Methods

• Rect *= t (Vector2D)

• Rect += t (Vector2D)

• Rect -= t (Vector2D)

• Rect /= t (Vector2D)

• void Bounding p1 (Vector2D) p2 (Vector2D)

• void Clear

• bool Clip cliprect (Rect)

• void Clip pt (Vector2D) excluderightbottom = true (bool)

• Vector2D GetBottomRight

• Vector2D GetCenter

• float GetHCenter

• Vector2D GetHalfSize

• float GetHeight

• Vector2D GetSize

• Vector2D GetTopLeft

• float GetVCenter

• float GetWidth

• void HMove h (float)

• void HTranslate h (float)

• void Inflate pt (Vector2D)

• void Interpolate value (float) a (Rect)

• int IsInside cliprect (Rect)

• bool IsInside pt (Vector2D)

• bool IsNull

• bool IsOutside cliprect (Rect)

• void Merge a (Rect)

• void Move pos (Vector2D)

• void Normalize

• void Scale s (Vector2D)

• void SetBottomRight v (Vector2D)

• void SetCenter v (Vector2D)

• void SetCenter center (Vector2D) halfsize (Vector2D)

• void SetCenter cx (float) cy (float) hw (float) hh (float)

• void SetCorners topleft (Vector2D) bottomright (Vector2D)

• void SetCorners l (float) t (float) r (float) b (float)

• void SetDimension position (Vector2D) size (Vector2D)

• void SetDimension x (float) y (float) w (float) h (float)

• void SetHalfSize v (Vector2D)

• void SetHeight h (float)

• void SetSize v (Vector2D)

• void SetTopLeft v (Vector2D)

• void SetWidth w (float)

• void Transform destScreen (Rect) srcScreen (Rect)

• void Transform destScreenSize (Vector2D) srcScreenSize (Vector2D)

• void TransformFromHomogeneous dest (Vector2D) srchom (Vector2D)

• void TransformFromHomogeneous screen (Rect)

• void TransformToHomogeneous screen (Rect)

• void Translate t (Vector2D)

• void VMove v (float)

• void VTranslate v (float)

RenderContext

This class has no equivalent in the Schematic

Parent Class

• Object

Methods

• void AttachViewpointToCamera cam (Camera)

• void ChangeCurrentRenderOptions Add (int) Remove (int)

• void ClientToScreen pt (Vector2D)

• int DumpToFile filename (str) rect (Rect) buffer (VXBUFFER_TYPE)

• int GetAmbientLight

• Camera GetAttachedCamera

• Material GetBackgroundMaterial

• void GetBoundingBox BBox (Bbox)

• int GetFogColor

• float GetFogDensity

• float GetFogEnd

• VXFOG_MODE GetFogMode

• float GetFogStart

• int GetHeight

• VX_PIXELFORMAT GetPixelFormat Bpp = 0 (int) Zbpp = 0 (int) StencilBpp = 0 (int)

• float GetSurfacesVideoMemoryOccupation NbTextures (int) NbSprites (int) TextureSize (float) SpriteSize (float)

• void GetViewRect rect (Rect)

• int GetWidth

• void GetWindowRect rect (Rect) ScreenRelative = false (bool)

• RenderObject Pick x (int) y (int) oRes (IntersectionDesc) iIgnoreUnpickable = false (bool)

• Entity2D Pick2D v (Vector2D)

• int RectPick r (Rect) oObjects (ObjectArray) Intersect = true (bool)

• void ScreenToClient pt (Vector2D)

• void ScreenToViewpoint i2DPosition (Vector2D) o3DPosition (Vector) iScreen = true (bool)

• void SetAmbientLight R (float) G (float) B (float)

• void SetAmbientLight Color (int)

• void SetCurrentMaterial mat (Material) Lit = true (bool)

• void SetFogColor Color (int)

• void SetFogDensity Density (float)

• void SetFogEnd End (float)

• void SetFogMode Mode (VXFOG_MODE)

• void SetFogStart Start (float)

• void Transform Dest (Vector) src (Vector) Ref (Entity3D)

RenderManager

This class has no equivalent in the Schematic

Methods

• void RegisterAABB iBox (Bbox) iColor (int) iRemainingTime = 0.000000 (float) iTransform = 0 (Matrix)

• void RegisterFrustum iFrustum (Frustum) iColor (int) iRemainingTime = 0.000000 (float) iTransform = 0 (Matrix)

• void RegisterNormal iRay (Ray) iColor (int) iRemainingTime = 0.000000 (float) iTransform = 0 (Matrix)

• void RegisterParabolic iStartPos (Vector) iSpeed (Vector) iAcceleration (Vector) iDrawingTime (float) iSubdivisions (int) iColor (int) iRemainingTime = 0.000000 (float) iTransform = 0 (Matrix)

• void RegisterPlane iPlane (Plane) iPoint (Vector) iColor (int) iRemainingTime = 0.000000 (float) iTransform = 0 (Matrix)

• void RegisterPoint iPoint (Vector) iColor (int) iRemainingTime = 0.000000 (float) iTransform = 0 (Matrix)

• void RegisterRectangle iRect (Rect) iColor (int) iRemainingTime = 0.000000 (float)

• void RegisterSphere iSphere (Sphere) iColor (int) iRemainingTime = 0.000000 (float) iTransform = 0 (Matrix) iSubdivisions = 32 (int)

RenderObject

This class has no equivalent in the Schematic

Parent Class

• BeObject

Methods

• int GetZOrder()

• void SetZOrder( int order )

Scene

Parent Class

• BeObject

Methods

• void Activate object (SceneObject) reset (bool)

• void AddObjectToScene object (SceneObject) dependencies = true (bool)

• void BeginAddSequence Begin (bool)

• void BeginRemoveSequence Begin (bool)

• ObjectArray ComputeObjectList cid (CK_CLASSID) derived = true (bool)

• void DeActivate object (SceneObject)

• int GetObjectCount

• Camera GetStartingCamera

• bool IsObjectActive object (SceneObject)

• bool IsObjectHere object (Object)

• void RemoveObjectFromScene object (SceneObject) dependencies = true (bool)

• void SetStartingCamera camera (Camera)

ScriptContext

This class has no equivalent in the Schematic

Methods

• void ActivateObject iObject (BeObject) activate (bool) reset (bool)

• bool ActivateScript iObject (BeObject) iScriptName (str) activate (bool) reset (bool)

• int AddAttributeType iName (str) iTargetClass (CK_CLASSID) iParamType (GUID)

• bool AddCategory iName (str)

• Object Copy iSrc (Object) iDynamic = true (bool) iDependencies = false (bool)

• Array CreateArray iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Camera CreateCamera iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Curve CreateCurve iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• CurvePoint CreateCurvePoint iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Entity2D CreateEntity2D iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Entity3D CreateEntity3D iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Grid CreateGrid iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Group CreateGroup iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Light CreateLight iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Material CreateMaterial iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Mesh CreateMesh iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Object CreateObject iObjectID (CK_CLASSID) iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Sprite CreateSprite iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Sprite3D CreateSprite3D iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• Texture CreateTexture iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• WaveSound CreateWaveSound iName (str) iDynamic = true (bool) iAddToCurrentScene = true (bool)

• void DestroyObject iObject (Object) iDependencies = false (bool)

• void FillObjectArrayByType array (ObjectArray) cid (CK_CLASSID) derived (bool) scene = 0 (Scene)

• bool GetAttribute iObject (BeObject) iAtt (int) oValue (ptr)

• int GetAttributeTypeCount

• int GetAttributeTypeIndex iName (str)

• str GetAttributeTypeName iAtt (int)

• void GetAttributeValue iObject (BeObject) iAttributName (str) iValue (ptr)

• ObjectArray GetAttributedObjects iName (str) iAnyScenes = false (bool)

• ObjectArray GetAttributedObjects iAttr (Attribute) iAnyScenes = false (bool)

• int GetCategoryCount

• str GetCategoryName iIndex (int)

• Level GetCurrentLevel

• Scene GetCurrentScene

• float GetDeltaTime

• BaseManager GetManagerByGuid guid (GUID)

• Object GetObject iObjID (int)

• Object GetObjectByName name (str) previous = 0 (Object)

• Object GetObjectByNameAndClass name (str) cid (CK_CLASSID) previous = 0 (Object)

• Object GetObjectByNameAndParentClass name (str) pcid (CK_CLASSID) previous = 0 (Object)

• RenderContext GetPlayerRenderContext

• RenderManager GetRenderManager

• bool GetStringValue iType (GUID) oString (String) oValue (ptr)

• void GetUnusedObjects array (ObjectArray)

• bool GetVariableValue iVariable (str) oValue (int)

• bool GetVariableValue iVariable (str) oValue (float)

• bool GetVariableValue iVariable (str) oValue (String)

• bool HasAttribute iObject (BeObject) iAttributName (str)

• bool HasAttribute iObject (BeObject) iAtt (int)

• bool Load iFileName (str) oLoadedObjects (ObjectArray) iDynamic = false (bool)

• void OutputToConsole iMessage (String) iBeep = false (bool)

• void OutputToConsole iMessage (str) iBeep = false (bool)

• void OutputToConsole iInt (int) iBeep = false (bool)

• void OutputToConsole iFloat (float) iBeep = false (bool)

• void OutputToScreen iMessage (String) iCol = -1 (int) iTime = 0.000000 (float)

• void OutputToScreen iMessage (str) iCol = -1 (int) iTime = 0.000000 (float)

• void OutputToScreen iInt (int) iCol = -1 (int) iTime = 0.000000 (float)

• void OutputToScreen iFloat (float) iCol = -1 (int) iTime = 0.000000 (float)

• void RemoveAttribute iObject (BeObject) iAttributName (str)

• bool RemoveAttribute iObject (BeObject) iAtt (int)

• bool RemoveAttributeType iType (int)

• void RemoveAttributeTypeList iTypes (IntArray)

• void RemoveAttributeTypeListByName iTypes (ArrayString)

• bool RemoveCategory iCat (str) iRemoveAttributes (bool)

• void RemoveCategoryList iCats (ArrayString) iRemoveAttributes (bool)

• void RemoveUserAttributs

• void SetAttribute iObject (BeObject) iAttributName (str) iValue (ptr)

• bool SetAttribute iObject (BeObject) iAtt (int) iValue (ptr)

• bool SetAttributeTypeCategory iType (int) iCat (str)

• bool SetAttributeTypeDefault iType (int) iDefault (str)

• bool SetAttributeTypeName iType (int) iName (str)

• bool SetCategoryName iOldName (str) iNewName (str)

• bool SetStringValue iType (GUID) iString (str) iValue (ptr)

• bool SetVariableValue iVariable (str) iValue (int)

• bool SetVariableValue iVariable (str) iValue (float)

• bool SetVariableValue iVariable (str) iValue (str)

• void Sleep iMilliSeconds (float)

• void UserProfileEnd iTimerIndex (int)

• void UserProfileStart iTimerIndex (int)

Sphere

This class has no equivalent in the Schematic

Methods

• bool == iSphere (Sphere)

• Vector Center

• int IsPointInside iPoint (Vector)

• int IsPointOnSurface iPoint (Vector)

• float Radius

Sprite

Parent Class

• Entity2D

Methods

• bool AlphaTestEnabled

• bool BlendingEnabled

• bool ColorModulateEnabled

• bool Create Width (int) Height (int) BPP = 32 (int) Slot = 0 (int)

• bool FilteringEnabled

• bool FreeVideoMemory

• VXCMPFUNC GetAlphaTestFunc

• char GetAlphaTestRefValue

• int GetCurrentSlot

• VX_PIXELFORMAT GetDesiredVideoFormat

• VXBLEND_MODE GetDestinationBlendMode

• int GetHeight

• Color GetModulateColor

• str GetMovieFileName

• int GetPickThreshold

• int GetPixel x (int) y (int) slot = -1 (int)

• CK_BITMAP_SAVEOPTIONS GetSaveOptions

• int GetSlotCount

• str GetSlotFileName Slot (int)

• VXBLEND_MODE GetSourceBlendMode

• int GetTransparentColor

• VX_PIXELFORMAT GetVideoPixelFormat

• int GetWidth

• bool IsInVideoMemory

• bool IsTransparent

• bool LoadImage Name (str) Slot = 0 (int)

• bool LoadMovie Name (str) width = 0 (int) height = 0 (int) Bpp = 16 (int)

• char LockSurfacePtr Slot = -1 (int)

• bool ReleaseAllSlots

• bool ReleaseSlot Slot (int)

• bool ReleaseSurfacePtr Slot = -1 (int)

• bool Restore Clamp = false (bool)

• void SetAlphaTest Enable (bool) RefValue (char) AlphaTestFunc (VXCMPFUNC)

• void SetBlending Enable (bool) SrcBlendMode (VXBLEND_MODE) DstBlendMode (VXBLEND_MODE)

• void SetColorModulate Enable (bool) color (Color)

• bool SetCurrentSlot Slot (int)

• void SetDesiredVideoFormat pf (VX_PIXELFORMAT)

• void SetFiltering Enable (bool)

• void SetPickThreshold iPickThreshold (int)

• bool SetPixel x (int) y (int) col (int) slot = -1 (int)

• void SetSaveOptions Options (CK_BITMAP_SAVEOPTIONS)

• bool SetSlotCount Count (int)

• bool SetSlotFileName Slot (int) Filename (str)

• void SetTransparent Transparency (bool)

• void SetTransparentColor Color (int)

• bool SystemToVideoMemory Dev (RenderContext) Clamping = false (bool)

Sprite3D

Parent Class

• Entity3D

Methods

• Material GetMaterial

• VXSPRITE3D_TYPE GetMode

• void GetOffset vect (Vector2D)

• void GetSize vect (Vector2D)

• void GetUVMapping rect (Rect)

• void SetMaterial Mat (Material)

• void SetMode Mode (VXSPRITE3D_TYPE)

• void SetOffset vect (Vector2D)

• void SetSize vect (Vector2D)

• void SetUVMapping rect (Rect)

String

Parent Class

• BaseString

Methods

• int != iStr (str)

• int != iStr (BaseString)

• String + iString (str)

• String + iString (BaseString)

• String + iValue (char)

• String + iValue (int)

• String + iValue (float)

• String += iValue (String)

• String += iValue (int)

• String += iValue (float)

• String += iValue (char)

• String += iValue (str)

• int - iStr (str)

• int - iStr (BaseString)

• int < iStr (str)

• int < iStr (BaseString)

• int <= iStr (str)

• int <= iStr (BaseString)

• String = iSrc (String)

• String = iSrc (str)

• String = iSrc (BaseString)

• int == iStr (str)

• int == iStr (BaseString)

• int > iStr (str)

• int > iStr (BaseString)

• int >= iStr (str)

• int >= iStr (BaseString)

• int Capacity

• int Compare iStr (BaseString)

• bool Contains iStr (BaseString)

• String Create iString (str) iLength = 0 (int)

• String CreateTail iString (BaseString) iStart = 0 (int)

• String Crop iStart (int) iLength (int)

• String Cut iStart (int) iLength (int)

• int Find iCar (char) iStart = 0 (int)

• int Find iStr (BaseString) iStart = 0 (int)

• String FormatTime iFormat (str)

• String FormatTime iTime (int) x iFormat (str)

• int ICompare iStr (BaseString)

• bool IContains iStr (BaseString)

• int IFind iStr (BaseString) iStart = 0 (int)

• int RFind iCar (char) iStart = -1 (int)

• int Replace iSrc (char) iDest (char)

• int Replace iSrc (BaseString) iDest (BaseString)

• void Reserve iLength (int)

• void Resize iLength (int)

• str Str

• String Strip

• String Substring iStart (int) iLength = 0 (int)

• String ToLower

• String ToUpper

• String Trim

• char [] i (int)

• char [] i (int)

StringTokenizer

This class has no equivalent in the Schematic

Methods

• str NextToken( str iPrevToken )

Texture

Parent Classes

• BeObject
• BitmapData

Methods

• int Create width (int) height (int) bpp = 32 (int) slot = 0 (int)

• bool EnsureVideoMemory ctx (RenderContext) Clamping = false (bool)

• bool FreeVideoMemory

• int GetMipmapCount

• bool IsInVideoMemory

• int LoadImage FileName (str) Slot = 0 (int)

• int LoadMovie MovieName (str)

• bool SystemToVideoMemory ctx (RenderContext) Clamping = false (bool)

• bool UseMipmap MipmapCount = -1 (int)

• bool VideoToSystemMemory

Timer

This class has no equivalent in the Schematic

Methods

• float Current()

• void Reset()

• float Split()

Vector

Members

• x (float)
• y (float)
• z (float)

Methods

• Vector *= v (Vector)

• Vector *= s (float)

• Vector + s (float)

• Vector += v (Vector)

• Vector - s (float)

• Vector -= v (Vector)

• Vector /= v (Vector)

• Vector /= s (float)

• void Absolute

• float Dot iV (Vector)

• float Magnitude

• void Normalize

• void Rotate M (Matrix)

• void Set X (float) Y (float) Z (float)

• float SquareMagnitude

• float [] i (int)

Vector2D

Members

• x (float)
• y (float)

Methods

• bool != v1 (Vector2D) v2 (Vector2D)

• Vector2D * v (Vector2D)

• Vector2D * f (float)

• Vector2D *= v (Vector2D)

• Vector2D *= s (float)

• Vector2D + v (Vector2D)

• Vector2D += v (Vector2D)

• Vector2D - v (Vector2D)

• Vector2D -= v (Vector2D)

• Vector2D / v (Vector2D)

• Vector2D / f (float)

• Vector2D /= v (Vector2D)

• Vector2D /= s (float)

• bool < v1 (Vector2D) v2 (Vector2D)

• bool <= v1 (Vector2D) v2 (Vector2D)

• bool == v1 (Vector2D) v2 (Vector2D)

• Vector2D Cross

• float Dot iV (Vector2D)

• float Magnitude

• float Max iSrc (Vector2D)

• float Min iSrc (Vector2D)

• Vector2D Normalize

• void Set x (float) y (float)

• void Set x (int) y (int)

• float SquareMagnitude

• float [] i (int)

Vector2DArray

This class has no equivalent in the Schematic

Methods

• Vector2DArray += iArray (Vector2DArray)

• Vector2DArray = iArray (Vector2DArray)

• void Clear

• bool Erase iValue (Vector2D)

• bool EraseAt iPos (int)

• bool IsHere iValue (Vector2D)

• Vector2D PopBack

• void PushBack iValue (Vector2D)

• void PushFront iValue (Vector2D)

• void Reserve iSize (int)

• void Resize iSize (int)

• int Size

• Vector2D [] iPos (int)

Vector4

Parent Class

• Vector

Members

• w (float)

Methods

• Vector4 *= v (Vector4)

• Vector4 *= v (Vector)

• Vector4 *= s (float)

• Vector4 + s (float)

• Vector4 += v (Vector4)

• Vector4 += v (Vector)

• Vector4 - s (float)

• Vector4 -= v (Vector4)

• Vector4 -= v (Vector)

• Vector4 /= v (Vector4)

• Vector4 /= v (Vector)

• Vector4 /= s (float)

• Vector4 = v (Vector)

• float Dot iV (Vector4)

• void Set X (float) Y (float) Z (float) W (float)

• float [] i (int)

Vector4Array

This class has no equivalent in the Schematic

Methods

• Vector4Array += iArray (Vector4Array)

• Vector4Array = iArray (Vector4Array)

• void Clear

• bool Erase iValue (Vector4)

• bool EraseAt iPos (int)

• bool IsHere iValue (Vector4)

• Vector4 PopBack

• void PushBack iValue (Vector4)

• void PushFront iValue (Vector4)

• void Reserve iSize (int)

• void Resize iSize (int)

• int Size

• Vector4 [] iPos (int)

VectorArray

This class has no equivalent in the Schematic

Methods

• VectorArray += iArray (VectorArray)

• VectorArray = iArray (VectorArray)

• void Clear

• bool Erase iValue (Vector)

• bool EraseAt iPos (int)

• bool IsHere iValue (Vector)

• Vector PopBack

• void PushBack iValue (Vector)

• void PushFront iValue (Vector)

• void Reserve iSize (int)

• void Resize iSize (int)

• int Size

• Vector [] iPos (int)

WaveFormat

This class has no equivalent in the Schematic

Members

• wFormatTag (int)
• nChannels (int)
• nSamplesPerSec (int)
• nAvgBytesPerSec (int)
• nBlockAlign (int)
• wBitsPerSample (int)
• cbSize (int)

WaveSound

Parent Class

• BeObject

Methods

• Entity3D GetAttachedEntity

• void GetCone InAngle (float) OutAngle (float) OutsideGain (float)

• void GetDirection Dir (Vector)

• bool GetFileStreaming

• float GetGain

• bool GetLoopMode

• void GetMinMaxDistance MinDistance (float) MaxDistance (float) MaxDistanceBehavior (int)

• void GetOrientation Dir (Vector) Up (Vector)

• float GetPan

• float GetPitch

• int GetPlayPosition

• int GetPlayedMs

• void GetPosition Pos (Vector)

• void GetSound3DInformation Pos (Vector) Dir (Vector) DistanceFromListener (float)

• str GetSoundFileName

• int GetSoundFormat Format (WaveFormat)

• int GetSoundLength

• CK_WAVESOUND_TYPE GetType

• void GetVelocity Pos (Vector)

• bool IsPaused

• bool IsPlaying

• void Pause

• void Play FadeIn = 0.000000 (float) FinalGain = 1.000000 (float)

• SoundHandle PlayMinion Background = true (bool) Ent = 0 (Entity3D) Position = 0 (Vector) Direction = 0 (Vector) MinDelay = 0.000000 (float) gain = 1.000000 (float)

• void PositionSound Object (Entity3D) Position = 0 (Vector) Direction = 0 (Vector) Commit = false (bool)

• void Resume

• void Rewind

• void SetCone InAngle (float) OutAngle (float) OutsideGain (float)

• int SetFileStreaming Enabled (bool) RecreateSound = false (bool)

• void SetGain Gain (float)

• void SetLoopMode Enabled (bool)

• void SetMinMaxDistance MinDistance (float) MaxDistance (float) MaxDistanceBehavior = 1 (int)

• void SetOrientation Dir (Vector) Up (Vector)

• void SetPan Pan (float)

• void SetPitch Rate (float)

• int SetSoundFileName const (str)

• void SetType Type (CK_WAVESOUND_TYPE)

• void SetVelocity Pos (Vector)

• void Stop FadeOut = 0.000000 (float)

---

Comments