emergent 8.2.2 LayerRelPos Class Reference
emergent 8.2.2   Home · Wiki Docs For: LayerRelPos · Emergent Help Browser 

LayerRelPos Class Reference

relative positioning of layers

See for more info: Wiki Docs For: LayerRelPos

 #include "Layer.h"

defined at: /mnt/ssd/grey/local/include/Emergent/Layer.h :66-133

Inherits From: taOBase, taBase

Inherited By: LayerRelPos*, LayerRelPos&, const LayerRelPos

Index: SubTypes, Members, Methods, Static Members, Static Methods, Expert Members, Expert Methods

Sub Types


SubType Documentation

enum LayerRelPos::RelPos

position of this layer relative to other

ConstantValueDescription
LayerRelPos::ABS_POS0x00000000use absolute positioning in abs_pos, not layer-relative positioning
LayerRelPos::RIGHT_OF0x00000001this is to the right of other (preferred form)
LayerRelPos::LEFT_OF0x00000002this is to the left of other (use of RIGHT_OF is preferable -- this can lead to negative pos)
LayerRelPos::BEHIND0x00000003this is behind other (preferred form)
LayerRelPos::FRONT_OF0x00000004this is in front of other (use of BEHIND is preferable -- this can lead to negative pos)
LayerRelPos::ABOVE0x00000005for 3d only: this is above other (z+1) (preferred form)
LayerRelPos::BELOW0x00000006for 3d only: this is below other (z-1) (use of ABOVE is preferable, this can lead to negative pos)

enum LayerRelPos::XAlign

alignment in X (horizontal) axis

ConstantValueDescription
LayerRelPos::LEFT0x00000000align left edge of this layer with left of other (+/- offset)
LayerRelPos::MIDDLE0x00000001align middle of this layer with middle of other (+/- offset)
LayerRelPos::RIGHT0x00000002align right edge of this layer with right of other (+/- offset)

enum LayerRelPos::YAlign

alignment in Y axis

ConstantValueDescription
LayerRelPos::FRONT0x00000000align front edge of this layer with front of other (+/- offset)
LayerRelPos::CENTER0x00000001align center of this layer with center of other (+/- offset)
LayerRelPos::BACK0x00000002align back edge of this layer with back of other (+/- offset)


Regular (preferred) Member and Method Documentation

Members

Member Category: _NoCategory

Methods

Method Category: UserData

Method Category: _NoCategory


Member Documentation

Member Category: _NoCategory

LayerRelPos::other : LayerRef

other layer to position relative to

LayerRelPos::rel : LayerRelPos::RelPos

relative position of this layer compared to other

LayerRelPos::space : int

how much space to add between layers -- for ABOVE, BELOW this is how much to add/subtract to y coordinate of this layer in 2D coordinates, to equate for the ABOVE or BELOW position in 3D coordinates that moves one z value up or down -- i.e., the max height of the row of layers that live within a given z coordinate

LayerRelPos::x_align : LayerRelPos::XAlign

horizontal (x-axis) alignment relative to other

LayerRelPos::x_off : int

how much offset to add for horizontal (x-axis) alignment

LayerRelPos::y_align : LayerRelPos::YAlign

Y-axis alignment relative to other

LayerRelPos::y_off : int

how much offset to add for Y-axis alignment


Method Documentation

Method Category: UserData

void taOBase::RemoveAllUserData ( )

get rid of our user data list entirely -- this is done automatically when saving something that has no user data items, but you can also force it with this method -- deletes the whole list

Show Source Code

Method Category: _NoCategory

bool LayerRelPos::ComputePos2D ( taVector2i& pos, Layer* lay )

compute new 3d position for this layer relative to other layer -- returns false if not using relative positioning (including if other is not set)

Show Source Code

bool LayerRelPos::ComputePos3D ( taVector3i& pos, Layer* lay )

compute new 3d position for this layer relative to other layer -- returns false if not using relative positioning (including if other is not set)

Show Source Code

taBase* taOBase::GetOwner ( )

Show Source Code

TypeDef* LayerRelPos::GetTypeDef ( )

Show Source Code

bool LayerRelPos::IsRel ( )

is layer using relative positioning

Show Source Code

void LayerRelPos::SetAbsPos ( )

Show Source Code

void LayerRelPos::SetBackAlign ( int y_offset = 0 )

set back Y alignment with given offset

Show Source Code

void LayerRelPos::SetCenterAlign ( int y_offset = 0 )

set center Y alignment with given offset

Show Source Code

void LayerRelPos::SetFrontAlign ( int y_offset = 0 )

set front Y alignment with given offset

Show Source Code

void LayerRelPos::SetLeftAlign ( int x_offset = 0 )

set left X alignment with given offset

Show Source Code

void LayerRelPos::SetMiddleAlign ( int x_offset = 0 )

set middle X alignment with given offset

Show Source Code

void LayerRelPos::SetRightAlign ( int x_offset = 0 )

set right X alignment with given offset

Show Source Code

taSigLink** taOBase::addr_sig_link ( )

Show Source Code

Static Member and Method Documentation

Static Members

Static Methods


Static Method Documentation


Expert Member and Method Documentation

Expert Members

Expert Member Category: taBase

Expert Methods

Expert Method Category: UserData


Expert Member Documentation

Expert Member Category: taBase

taOBase::owner : taBase*

pointer to owner

taOBase::user_data_ : UserDataItem_List*

storage for user data (created if needed) DO NOT ACCESS this list directly -- use the GetUserData / SetUserData etc interface!


Expert Method Documentation

Expert Method Category: UserData

UserDataItem_List* taOBase::GetUserDataList ( bool force = false )

gets the userdatalist for this class

Show Source Code


Copyright © 2017Regents of the University of Colorado, Carnegie Mellon University, Princeton University.
emergent 8.2.2