SDS2 Parametric API
 All Classes Namespaces Functions Variables Pages
Classes | Functions | Variables
view Namespace Reference

Classes

class  error
 No documentation available. More...
class  MemberProjectionViewUse
 No documentation available. More...
class  MemberViewTuple
 MemberViewTuple(global_to_view, max_clip_in_view_coords, min_clip_in_view_coords, type, cut_from, cut_from_type, scale, offset, use, projection_use, is_user, excludes_clip_region, is_projection_view, is_forced) More...
class  MemberViewType
 No documentation available. More...
class  MemberViewUse
 No documentation available. More...

Functions

def AddMemberPresetView
def AddMemberView
def DeleteMemberView
def EyeUpLooking
def GetMemberViews
def MemberPresetView
def SetupDetailScale
def View
def ViewFactory

Variables

float MAX_CLIP_LIMIT_INCHES = 240000.0
int MAX_VIEW_COUNT = 60
float MIN_CLIP_LIMIT_INCHES = 240000.0
float UNBOUNDED_DIMENSION_INCHES = 480000.0

Function Documentation

def view.AddMemberPresetView (   member,
  preset_id,
  kwds 
)
Returns
Instance of type MemberViewTuple
     Syntactic sugar for AddMemberView(member, MemberPresetView(member, preset_id, **kwds))
def view.AddMemberView (   member,
  view 
)
Returns
Instance of type object
     Add view to member and return a copy of what was added.
     The return value does not necessarily equal view, e.g. properties
     such as is_user, cut_from, and global_to_view might be different
     Example: added = AddMemberView(1, ViewFactory())
def view.DeleteMemberView (   member,
  view_index 
)
Returns
Instance of type object
     Delete and return the view GetMemberViews(member)[view_index]
 
     Syntactic sugar for DeleteMemberView(member, GetMemberViews(member).index(view))
Note
Additional signature: DeleteMemberView( (object)member, (object)view) -> object
def view.EyeUpLooking (   global_to_view)
Returns
Instance of type object
     Return a tuple representing the view transform's position
     and orientation in global coordinates
     Example: eye, up, looking = EyeUpLooking(GetMemberViews(1)[0].global_to_view)
 
     Syntactic sugar for EyeUpLooking(view.global_to_view)
Note
Additional signature: EyeUpLooking( (object)view) -> object
def view.GetMemberViews (   member)
Returns
Instance of type object
     Return the list of views for the specified member
def view.MemberPresetView (   member,
  preset_id,
  kwds 
)
Returns
Instance of type MemberViewTuple
     For the given member and preset_id, compute the default
     MemberViewTuple t and return t._replace(**kwds)
     Example:
       from Point3D import Point3D as Pt
       p = Pt(MAX_CLIP_LIMIT_INCHES, MAX_CLIP_LIMIT_INCHES, 12.)
       MemberPresetView(1, MemberViewType.END0, max_clip_in_view_coords=p)
def view.SetupDetailScale (   member = 0)
Returns
Instance of type float
     Return the detail scale defined in setup
def view.View (   args)
 View object
def view.ViewFactory (   eye = Point3D(0, 0,
  up = Point3D(0, 1,
  looking = Point3D(0, 0,
  type = view.MemberViewType.DETAIL,
  cut_from_type = view.MemberViewType.MAIN,
  width = 480000.0,
  height = 480000.0,
  near = 240000.0,
  far = 240000.0,
  scale = 1.0,
  offset = 0.0,
  use = view.MemberViewUse.UNSPECIFIED,
  projection_use = view.MemberProjectionViewUse.UNSPECIFIED,
  excludes_clip_region = False,
  is_projection_view = False 
)
Returns
Instance of type object
     Return a MemberViewTuple initialized according to specified parameters.
     eye, up, looking define the view position and orientation in global
     coordinates. width, height, near, and far define the clipping region in
     global coordinates such that the width and height are centered at
     the eye. The far clipping plane runs through the point (eye + far*looking)
     and the near clipping plane runs through (eye - near*looking)

Variable Documentation

float view.MAX_CLIP_LIMIT_INCHES = 240000.0
int view.MAX_VIEW_COUNT = 60
float view.MIN_CLIP_LIMIT_INCHES = 240000.0
float view.UNBOUNDED_DIMENSION_INCHES = 480000.0