rfm2.vp.geo.ramp.Ramp Class Reference

Inheritance diagram for rfm2.vp.geo.ramp.Ramp:

Collaboration diagram for rfm2.vp.geo.ramp.Ramp:

Public Member Functions
def	__init__
def	is_static
def	opacity
def	vtx_buffer_count
def	vtx_buffer
def	color_buffer
def	idx_buffer
def	set_input_params
Public Member Functions inherited from rfm2.vp.geo.base.Vp2GeometryBase
def	__init__
def	defaulted_value
def	is_static
def	instance_draw_method
def	instance_display_mode
def	instance_vp2_primitive
def	instance_enabled
def	opacity
def	get_input_params
def	set_input_params
def	vtx_buffer_count
def	vtx_buffer
def	has_uvs
def	uv_buffer
def	color_buffer
def	idx_buffer

Public Attributes
	subdivs
	disk
	rect
	mode
	begin_dist
	end_dist
	color
	ramp_data
Public Attributes inherited from rfm2.vp.geo.base.Vp2GeometryBase
	id
	textured
	num_instances
	inst_display_mode
	inst_draw_method
	inst_index_buffer
	inst_vp_shader
	method
	kwargs
	is_deforming_when_transformed

Constructor & Destructor Documentation

def rfm2.vp.geo.ramp.Ramp.__init__	(		self,
			jsondict
	)

Member Function Documentation

def rfm2.vp.geo.ramp.Ramp.color_buffer

(

self

)

Return per-vertex color data as a list of lists. It should be
ordered exactly like the vertex buffer points and have the same size
as the vxt buffer.
The default implementation returns a zero-filled list the same size
as the vtx buffer to keep the uv buffer aligned with the vtx buffer.
NOTE: colors have FOUR components: R, G, B, A.

Here is the call graph for this function:

def rfm2.vp.geo.ramp.Ramp.idx_buffer	(		self,
			idx_buffer,
			num_vtx,
			start_idx,
			inst_idx
	)

Fill the provided index buffer to draw the shape.
NOTE: This index buffer must be valid for all vertex buffers,
i.e. positions and uvs.

def rfm2.vp.geo.ramp.Ramp.is_static

(

self

)

Tells the vp code if the geometry is static or deforming, like a spot
light frustum for example. Defaults to True.

def rfm2.vp.geo.ramp.Ramp.opacity

(

self

)

Returns the opacity for that shape.

def rfm2.vp.geo.ramp.Ramp.set_input_params	(		self,
			obj,
			kwargs
	)

Update internal input param values using kwargs.

def rfm2.vp.geo.ramp.Ramp.vtx_buffer

(

self

)

Return a list of vertices (list) in local space.

def rfm2.vp.geo.ramp.Ramp.vtx_buffer_count

(

self

)

Return the number of vertices in this buffer.

Member Data Documentation

rfm2.vp.geo.ramp.Ramp.begin_dist

rfm2.vp.geo.ramp.Ramp.color

rfm2.vp.geo.ramp.Ramp.disk

rfm2.vp.geo.ramp.Ramp.end_dist

rfm2.vp.geo.ramp.Ramp.mode

rfm2.vp.geo.ramp.Ramp.ramp_data

rfm2.vp.geo.ramp.Ramp.rect

rfm2.vp.geo.ramp.Ramp.subdivs

---

The documentation for this class was generated from the following file:

• /data/wlw/renderman_root/rat/apps/rfm/scripts/rfm2/vp/geo/ramp.py